Skip to main content

Documentation index: llms.txt. This page is also available as markdown: append .md to this URL or send Accept: text/markdown.

GetSchemasOutput

Paginated response from the executed query or mutation

type GetSchemasOutput {
  greatestId: String
  nbPerPage: Int!
  page: Int
  totalCount: Int!
  data: [Schema!]!
}

Fields​

GetSchemasOutput.greatestId ● String scalar general​

The greatest id returned, to pass as the next 'greaterThanId' when using cursor-based pagination. Returned only when page is not used.

GetSchemasOutput.nbPerPage ● Int! non-null scalar general​

Number of entities to return per page

GetSchemasOutput.page ● Int scalar general​

The page number (start at 0). Returned only when greaterThanId is not used.

GetSchemasOutput.totalCount ● Int! non-null scalar general​

The total number of entities

GetSchemasOutput.data ● [Schema!]! non-null object schemas​

Field containing the response from the executed query or mutation

Example​

{
  "greatestId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "nbPerPage": 50,
  "page": 0,
  "totalCount": 100,
  "data": [
    {
      "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "description": "Default Postgres schema",
      "externalId": "public",
      "isHidden": false,
      "name": "public",
      "slug": "schema_public",
      "databaseId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "database": {
        "sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "warehouse": {
          "lastRefreshedAt": 1758555879800,
          "origin": "EXTRACTION",
          "technology": "SNOWFLAKE",
          "type": "COMMUNICATION",
          "createdAt": 1758555879800,
          "deletedAt": 1758555879800,
          "updatedAt": 1758555879800
        }
      }
    }
  ]
}

Returned By​