ERD queries schema

service.dataset.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

rmGetDataSet

Description

Returns the dataset information for the specified project and dataset path.

Response

Returns a DataSetInfo!

Arguments
Name Description
projectId - ID!
datasetPath - String!

Example

Query
query rmGetDataSet(
  $projectId: ID!,
  $datasetPath: String!
) {
  rmGetDataSet(
    projectId: $projectId,
    datasetPath: $datasetPath
  ) {
    displayName
    description
    draft
    queries {
      ...DataSetQueryInfoFragment
    }
    datasetPath
    projectId
  }
}
Variables
{"projectId": "<id>", "datasetPath": "<string>"}
Response
{
  "data": {
    "rmGetDataSet": {
      "displayName": "<string>",
      "description": "<string>",
      "draft": "<boolean>",
      "queries": [DataSetQueryInfo],
      "datasetPath": "<string>",
      "projectId": "<id>"
    }
  }
}

Mutations

asyncRmExecuteDataSet

Description

Creates async task for executing queries from the provided dataset

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID!
datasetPath - String!
queryIndex - Int!
connectionId - ID!
contextId - ID!
resultId - ID
filter - SQLDataFilter
dataFormat - ResultDataFormat

Example

Query
mutation asyncRmExecuteDataSet(
  $projectId: ID!,
  $datasetPath: String!,
  $queryIndex: Int!,
  $connectionId: ID!,
  $contextId: ID!,
  $resultId: ID,
  $filter: SQLDataFilter,
  $dataFormat: ResultDataFormat
) {
  asyncRmExecuteDataSet(
    projectId: $projectId,
    datasetPath: $datasetPath,
    queryIndex: $queryIndex,
    connectionId: $connectionId,
    contextId: $contextId,
    resultId: $resultId,
    filter: $filter,
    dataFormat: $dataFormat
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "<id>",
  "datasetPath": "<string>",
  "queryIndex": "<int>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultId": "<id>",
  "filter": SQLDataFilter,
  "dataFormat": "resultset"
}
Response
{
  "data": {
    "asyncRmExecuteDataSet": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}
Mutations

rmCreateDataSet

Description

Creates or updates a dataset in the specified project.

Response

Returns a DataSetInfo!

Arguments
Name Description
projectId - ID!
datasetPath - String!
datasetConfig - DataSetConfig
forceOverwrite - Boolean

Example

Query
mutation rmCreateDataSet(
  $projectId: ID!,
  $datasetPath: String!,
  $datasetConfig: DataSetConfig,
  $forceOverwrite: Boolean
) {
  rmCreateDataSet(
    projectId: $projectId,
    datasetPath: $datasetPath,
    datasetConfig: $datasetConfig,
    forceOverwrite: $forceOverwrite
  ) {
    displayName
    description
    draft
    queries {
      ...DataSetQueryInfoFragment
    }
    datasetPath
    projectId
  }
}
Variables
{
  "projectId": "<id>",
  "datasetPath": "<string>",
  "datasetConfig": DataSetConfig,
  "forceOverwrite": "<boolean>"
}
Response
{
  "data": {
    "rmCreateDataSet": {
      "displayName": "<string>",
      "description": "<string>",
      "draft": "<boolean>",
      "queries": [DataSetQueryInfo],
      "datasetPath": "<string>",
      "projectId": "<id>"
    }
  }
}

Types

AsyncTaskInfo

Description

Async types

Fields
Field Name Description
id - String! Task unique identifier
name - String Async task name
running - Boolean! Indicates if the task is currently running
status - String Current status of the async task
error - ServerError Error information if the task failed
taskResult - Object Task result. Can be some kind of identifier to obtain real result using another API function
Example
{
  "id": "<string>",
  "name": "<string>",
  "running": "<boolean>",
  "status": "<string>",
  "error": ServerError,
  "taskResult": "<object>"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

DataSetConfig

Fields
Input Field Description
displayName - String!
description - String
draft - Boolean
queries - [DataSetQueryConfig!]!
Example
{
  "displayName": "<string>",
  "description": "<string>",
  "draft": "<boolean>",
  "queries": [DataSetQueryConfig]
}
Types

DataSetInfo

Fields
Field Name Description
displayName - String!
description - String
draft - Boolean!
queries - [DataSetQueryInfo!]!
datasetPath - String!
projectId - ID!
Example
{
  "displayName": "<string>",
  "description": "<string>",
  "draft": "<boolean>",
  "queries": [DataSetQueryInfo],
  "datasetPath": "<string>",
  "projectId": "<id>"
}
Types

DataSetQueryConfig

Fields
Input Field Description
id - String
description - String
datasourceId - ID!
catalog - String
schema - String
queryText - String!
dataFilter - SQLDataFilter
Example
{
  "id": "<string>",
  "description": "<string>",
  "datasourceId": "<id>",
  "catalog": "<string>",
  "schema": "<string>",
  "queryText": "<string>",
  "dataFilter": SQLDataFilter
}
Types

DataSetQueryInfo

Fields
Field Name Description
id - String!
queryText - String!
datasourceId - String!
description - String
catalog - String
schema - String
dataFilter - SQLDataFilterInfo
Example
{
  "id": "<string>",
  "queryText": "<string>",
  "datasourceId": "<string>",
  "description": "<string>",
  "catalog": "<string>",
  "schema": "<string>",
  "dataFilter": SQLDataFilterInfo
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
"<float>"
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

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
"<int>"
Types

Object

Description

Any object (JSON)

Example
"<object>"
Types

ResultDataFormat

Values
Enum Value Description

resultset

document

graph

timeseries
Example
"resultset"
Types

SQLDataFilter

Fields
Input Field Description
offset - Float Row offset. We use Float because offset may be bigger than 32 bit.
limit - Int
constraints - [SQLDataFilterConstraint]
anyConstraint - Boolean When true constraints are combined with OR instead of AND
where - String
orderBy - String
Example
{
  "offset": "<float>",
  "limit": "<int>",
  "constraints": [SQLDataFilterConstraint],
  "anyConstraint": "<boolean>",
  "where": "<string>",
  "orderBy": "<string>"
}
Types

SQLDataFilterConstraint

Fields
Input Field Description
attributeName - String Either attributeName or attributePosition must be specified
attributePosition - Int
orderPosition - Int
orderAsc - Boolean
criteria - String
operator - String
value - Object
Example
{
  "attributeName": "<string>",
  "attributePosition": "<int>",
  "orderPosition": "<int>",
  "orderAsc": "<boolean>",
  "criteria": "<string>",
  "operator": "<string>",
  "value": "<object>"
}
Types

SQLDataFilterConstraintInfo

Fields
Field Name Description
orderPosition - Int
orderAsc - Boolean
criteria - String
operator - String
value - Object
Example
{
  "orderPosition": "<int>",
  "orderAsc": "<boolean>",
  "criteria": "<string>",
  "operator": "<string>",
  "value": "<object>"
}
Types

SQLDataFilterInfo

Fields
Field Name Description
where - String
constraints - [SQLDataFilterConstraintInfo!]!
Example
{
  "where": "<string>",
  "constraints": [SQLDataFilterConstraintInfo]
}
Types

ServerError

Description

Various server errors descriptor

Fields
Field Name Description
message - String Error message text
errorCode - String Retrieves the vendor-specific error code
errorType - String Type/category of the error
stackTrace - String Stack trace for debugging
causedBy - ServerError Nested error that caused this error (recursive)
Example
{
  "message": "<string>",
  "errorCode": "<string>",
  "errorType": "<string>",
  "stackTrace": "<string>",
  "causedBy": ServerError
}
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