Metadata queries schema

service.metadata.graphqls

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.

API Endpoints
https://your-server-address/api/gql

Queries

metadataGetNodeDDL

Description

Returns node DDL for the specified node ID

Response

Returns a String

Arguments
Name Description
nodeId - ID!
options - Object

Example

Query
query metadataGetNodeDDL(
  $nodeId: ID!,
  $options: Object
) {
  metadataGetNodeDDL(
    nodeId: $nodeId,
    options: $options
  )
}
Variables
{"nodeId": "<id>", "options": "<object>"}
Response
{"data": {"metadataGetNodeDDL": "<string>"}}
Queries

metadataGetNodeExtendedDDL

Description

Returns extended node DDL for the specified node ID (e.g., Oracle or MySQL package)

Response

Returns a String

Arguments
Name Description
nodeId - ID!

Example

Query
query metadataGetNodeExtendedDDL($nodeId: ID!) {
  metadataGetNodeExtendedDDL(nodeId: $nodeId)
}
Variables
{"nodeId": "<id>"}
Response
{
  "data": {
    "metadataGetNodeExtendedDDL": "<string>"
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"<id>"
Types

Object

Description

Any object (JSON)

Example
"<object>"
Types

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.

Example
"<string>"
Documentation by Anvil SpectaQL