Skip to main content

Advanced Introspection

Introspection allows you to query the database system to understand the operations you can perform on your schema.

To learn more about Introspection, visit the GraphQL website.

Retrieving Your Schema

Retrieving your schema is a two-step process.

Step 1. Paste the following query into the left pane of the API Explorer to retrieve introspection information about your schema.

query Introspection {
system {
introspection {
url
}
}
}
{
"data": {
"system": {
"introspection": {
"url": "https://8base-user-uploads-3bjwok12adad.s3.amazonaws.com/
introspection/816nag82jdg2"
}
}
}
}

The response returns a very long URL.

Note: The URL provided in this example is truncated and is for demonstration purposes only.



Step 2. Copy the URL returned in the response and paste it into a browser window; this will download a JSON file.

If you open the JSON file, you will see a description of all the possible types and operations available for the schema.

Querying Your Schema Interactively

You can query your schema interactively to learn more about the data types and operations available.

Query Data Types

Running the following query returns the kind and name of the different data types.

query qSchema {
__schema {
types {
kind
name
}
}
}
{
"data": {
"__schema": {
"types": [
{
"kind": "OBJECT",
"name": "ImportedTable"
},
{
"kind": "OBJECT",
"name": "MissingRelation"
},
{
"kind": "INTERFACE",
"name": "FunctionInfo"
},
{
"kind": "ENUM",
"name": "FunctionType"
},
{
"kind": "OBJECT",
"name": "Application"
},
{
"kind": "ENUM",
"name": "ApplicationStatusEnum"
},
{
"kind": "OBJECT",
"name": "FunctionWebhookInfo"
}
]
}
}
}

You can query for multiple type properties such as name, kind, and description.

Running the following query returns the kind, name, and description of the different data types.

query qSchema {
__schema {
types {
kind
name
description
}
}
}
{
"data": {
"__schema": {
"types": [
{
"kind": "SCALAR",
"name": "Boolean",
"description": "The `Boolean` scalar type represents `true` or `false`."
},
{
"kind": "OBJECT",
"name": "WorkspaceInfo",
"description": "LoginResponseWorkspace name and id"
},
{
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data,
represented as UTF-8 character sequences. The String type is most often
used by GraphQL to represent free-form human-readable text."
},
{
"kind": "OBJECT",
"name": "SuccessResponse",
"description": null
},
{
"kind": "OBJECT",
"name": "AsyncSession",
"description": "Async Session"
},
{
"kind": "SCALAR",
"name": "DateTime",
"description": "A date-time string at UTC, such as `2007-12-25T16:15:30Z`,
compliant with the `date-time` format outlined in section 5.6 of the
RFC 3339 profile of the ISO 8601 standard for representation of dates
and times using the Gregorian calendar."
}
]
}
}
}

You can also query for the available fields in your schema.

Running the following query returns a list of fields, which includes the field name and type properties.

query qSchema {
__schema {
types {
kind
name
fields {
name
type {
name
description
}
}
}
}
}
{
"data": {
"__schema": {
"types": [
{
"kind": "OBJECT",
"name": "__EnumValue",
"fields": [
{
"name": "name",
"type": {
"name": null,
"description": null
}
},
{
"name": "description",
"type": {
"name": "String",
"description": "The `String` scalar type represents textual data,
represented as UTF-8 character sequences. The String type is most
often used by GraphQL to represent free-form human-readable text."
}
},
{
"name": "isDeprecated",
"type": {
"name": null,
"description": null
}
},
{
"name": "deprecationReason",
"type": {
"name": "String",
"description": "The `String` scalar type represents textual data,
represented as UTF-8 character sequences. The String type is most
often used by GraphQL to represent free-form human-readable text."
}
}
]
}
]
}
}
}

Managing Introspection Settings

You have the option of not exposing your introspection information. If you decide to do so, you can turn it off and on as needed.

Checking the Environment Settings

Running the following query will check the environment settings for your introspection.

The response returns a null value if your environment settings are not set up.

query ReadSettings {
system {
environmentSettings {
introspection
}
}
}
{
'data': {
'system': {
'environmentSettings': {
'introspection': null
}
}
}
}

Turning Introspection Off and On

Introspection can be turned off and on by running a mutation against the system.

The mutation name can be anything, but it should be something that describes what the mutation does.

Turning Introspection Off

Running the following mutation will turn off introspection.

mutation mName {
system {
environmentSetup(
data: {
introspection: false
}
) {
success
}
}
}
{
"data": {
"system": {
"environmentSetup": {
"success": true
}
}
}
}

Attempting to query the schema after introspection has been turned off will display an error.

query qSchema {
__schema {
types {
kind
name
}
}
}
{
'errors': {
'message': { 'Introspection was turned off' ,
'locations': [
{
'line': 2,
'column' : 3
}
]
}
}
}

Turning Introspection On

Running the following mutation will turn introspection on.

mutation mutationName {
system {
environmentSetup(
data: {
introspection: true
}
) {
success
}
}
}
{
"data": {
"system": {
"environmentSetup": {
"success": true
}
}
}
}