SQL helpers schema

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

`asyncSqlGroupingResultSet`

Description

Creates async task to get grouped SQL results

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID`
`contextId` - `ID!`
`connectionId` - `ID!`
`originalResultsId` - `ID!`	Original results ID to group
`currentResultsId` - `ID`	Current results ID is needed to apply filters/sorting on top of grouping
`columnNames` - `[String!]`
`functions` - `[String!]`
`showDuplicatesOnly` - `Boolean`
`filter` - `SQLDataFilter`
`dataFormat` - `ResultDataFormat`
`isInteractive` - `Boolean`

Example

Query

query asyncSqlGroupingResultSet(
  $projectId: ID,
  $contextId: ID!,
  $connectionId: ID!,
  $originalResultsId: ID!,
  $currentResultsId: ID,
  $columnNames: [String!],
  $functions: [String!],
  $showDuplicatesOnly: Boolean,
  $filter: SQLDataFilter,
  $dataFormat: ResultDataFormat,
  $isInteractive: Boolean
) {
  asyncSqlGroupingResultSet(
    projectId: $projectId,
    contextId: $contextId,
    connectionId: $connectionId,
    originalResultsId: $originalResultsId,
    currentResultsId: $currentResultsId,
    columnNames: $columnNames,
    functions: $functions,
    showDuplicatesOnly: $showDuplicatesOnly,
    filter: $filter,
    dataFormat: $dataFormat,
    isInteractive: $isInteractive
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "<id>",
  "contextId": "<id>",
  "connectionId": "<id>",
  "originalResultsId": "<id>",
  "currentResultsId": "<id>",
  "columnNames": "<string>",
  "functions": "<string>",
  "showDuplicatesOnly": "<boolean>",
  "filter": SQLDataFilter,
  "dataFormat": "resultset",
  "isInteractive": "<boolean>"
}

Response

{
  "data": {
    "asyncSqlGroupingResultSet": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Queries

`sqlCompletionProposals`

Description

Returns proposals for SQL completion at the specified position in the query

Response

Returns [SQLCompletionProposal]

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`query` - `String!`
`position` - `Int!`
`maxResults` - `Int`
`simpleMode` - `Boolean`

Example

Query

query sqlCompletionProposals(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!,
  $position: Int!,
  $maxResults: Int,
  $simpleMode: Boolean
) {
  sqlCompletionProposals(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query,
    position: $position,
    maxResults: $maxResults,
    simpleMode: $simpleMode
  ) {
    displayString
    type
    score
    replacementString
    replacementOffset
    replacementLength
    cursorPosition
    icon
    nodePath
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "query": "<string>",
  "position": "<int>",
  "maxResults": "<int>",
  "simpleMode": "<boolean>"
}

Response

{
  "data": {
    "sqlCompletionProposals": [
      {
        "displayString": "<string>",
        "type": "<string>",
        "score": "<int>",
        "replacementString": "<string>",
        "replacementOffset": "<int>",
        "replacementLength": "<int>",
        "cursorPosition": "<int>",
        "icon": "<string>",
        "nodePath": "<string>"
      }
    ]
  }
}

Queries

`sqlDialectInfo`

Description

Returns SQL dialect info for the specified connection

Response

Returns an SQLDialectInfo

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`

Example

Query

query sqlDialectInfo(
  $projectId: ID,
  $connectionId: ID!
) {
  sqlDialectInfo(
    projectId: $projectId,
    connectionId: $connectionId
  ) {
    name
    dataTypes
    functions
    reservedWords
    quoteStrings
    singleLineComments
    multiLineComments
    catalogSeparator
    structSeparator
    scriptDelimiter
    supportsExplainExecutionPlan
  }
}

Variables

{"projectId": "<id>", "connectionId": "<id>"}

Response

{
  "data": {
    "sqlDialectInfo": {
      "name": "<string>",
      "dataTypes": ["<string>"],
      "functions": ["<string>"],
      "reservedWords": ["<string>"],
      "quoteStrings": ["<string>"],
      "singleLineComments": ["<string>"],
      "multiLineComments": ["<string>"],
      "catalogSeparator": "<string>",
      "structSeparator": "<string>",
      "scriptDelimiter": "<string>",
      "supportsExplainExecutionPlan": "<boolean>"
    }
  }
}

Queries

`sqlEntityQueryGenerators`

Description

Returns list of all available entity query generators

Response

Returns [SQLQueryGenerator!]!

Arguments

Name	Description
`nodePathList` - `[String!]!`

Example

Query

query sqlEntityQueryGenerators($nodePathList: [String!]!) {
  sqlEntityQueryGenerators(nodePathList: $nodePathList) {
    id
    label
    description
    order
    multiObject
  }
}

Variables

{"nodePathList": "<string>"}

Response

{
  "data": {
    "sqlEntityQueryGenerators": [
      {
        "id": "<string>",
        "label": "<string>",
        "description": "<string>",
        "order": "<int>",
        "multiObject": "<boolean>"
      }
    ]
  }
}

Queries

`sqlFormatQuery`

Description

Formats SQL query and returns formatted query string

Response

Returns a String!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`query` - `String!`

Example

Query

query sqlFormatQuery(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!
) {
  sqlFormatQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "query": "<string>"
}

Response

{"data": {"sqlFormatQuery": "<string>"}}

Queries

`sqlGenerateEntityQuery`

use asyncSqlGenerateEntityQuery

Description

Generates SQL query for the specified entity query generator.

Response

Returns a String!

Arguments

Name	Description
`generatorId` - `String!`
`nodePathList` - `[String!]!`
`generatorOptions` - `SQLQueryGeneratorOptions`

Example

Query

query sqlGenerateEntityQuery(
  $generatorId: String!,
  $nodePathList: [String!]!,
  $generatorOptions: SQLQueryGeneratorOptions
) {
  sqlGenerateEntityQuery(
    generatorId: $generatorId,
    nodePathList: $nodePathList,
    generatorOptions: $generatorOptions
  )
}

Variables

{
  "generatorId": "<string>",
  "nodePathList": "<string>",
  "generatorOptions": SQLQueryGeneratorOptions
}

Response

{
  "data": {
    "sqlGenerateEntityQuery": "<string>"
  }
}

Queries

`sqlGenerateGroupingQuery`

use asyncSqlGroupingResultSet (25.3.1)

Description

Generates SQL query for grouping data in the specified results

Response

Returns a String!

Arguments

Name	Description
`projectId` - `ID`
`contextId` - `ID!`
`connectionId` - `ID!`
`resultsId` - `ID!`
`columnNames` - `[String!]`
`functions` - `[String!]`
`showDuplicatesOnly` - `Boolean`

Example

Query

query sqlGenerateGroupingQuery(
  $projectId: ID,
  $contextId: ID!,
  $connectionId: ID!,
  $resultsId: ID!,
  $columnNames: [String!],
  $functions: [String!],
  $showDuplicatesOnly: Boolean
) {
  sqlGenerateGroupingQuery(
    projectId: $projectId,
    contextId: $contextId,
    connectionId: $connectionId,
    resultsId: $resultsId,
    columnNames: $columnNames,
    functions: $functions,
    showDuplicatesOnly: $showDuplicatesOnly
  )
}

Variables

{
  "projectId": "<id>",
  "contextId": "<id>",
  "connectionId": "<id>",
  "resultsId": "<id>",
  "columnNames": "<string>",
  "functions": "<string>",
  "showDuplicatesOnly": "<boolean>"
}

Response

{
  "data": {
    "sqlGenerateGroupingQuery": "<string>"
  }
}

Queries

`sqlGenerateResultSetQuery`

Description

Returns an auto-generated SQL query based on provided rows data. Uses generatorId value to establish the type of query (e.g. SELECT or INSERT)

Response

Returns a String!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`generatorId` - `SQLResultSetGeneratorId!`
`resultsId` - `ID!`
`selectedRows` - `[SQLResultRow!]!`
`generatorOptions` - `SQLQueryGeneratorOptions`

Example

Query

query sqlGenerateResultSetQuery(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $generatorId: SQLResultSetGeneratorId!,
  $resultsId: ID!,
  $selectedRows: [SQLResultRow!]!,
  $generatorOptions: SQLQueryGeneratorOptions
) {
  sqlGenerateResultSetQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    generatorId: $generatorId,
    resultsId: $resultsId,
    selectedRows: $selectedRows,
    generatorOptions: $generatorOptions
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "generatorId": "dataSelect",
  "resultsId": "<id>",
  "selectedRows": [SQLResultRow],
  "generatorOptions": SQLQueryGeneratorOptions
}

Response

{
  "data": {
    "sqlGenerateResultSetQuery": "<string>"
  }
}

Queries

`sqlListContexts`

Description

Lists SQL contexts for a connection (optional) or returns the particular context info

Response

Returns [SQLContextInfo]!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID`
`contextId` - `ID`

Example

Query

query sqlListContexts(
  $projectId: ID,
  $connectionId: ID,
  $contextId: ID
) {
  sqlListContexts(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    id
    projectId
    connectionId
    autoCommit
    defaultCatalog
    defaultSchema
  }
}

Variables

{"projectId": "<id>", "connectionId": "<id>", "contextId": "<id>"}

Response

{
  "data": {
    "sqlListContexts": [
      {
        "id": "<id>",
        "projectId": "<id>",
        "connectionId": "<id>",
        "autoCommit": "<boolean>",
        "defaultCatalog": "<string>",
        "defaultSchema": "<string>"
      }
    ]
  }
}

Queries

`sqlParseQuery`

Description

Parses SQL query and returns query info with start and end positions

Response

Returns an SQLScriptQuery!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`script` - `String!`
`position` - `Int!`

Example

Query

query sqlParseQuery(
  $projectId: ID,
  $connectionId: ID!,
  $script: String!,
  $position: Int!
) {
  sqlParseQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    script: $script,
    position: $position
  ) {
    start
    end
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "script": "<string>",
  "position": "<int>"
}

Response

{"data": {"sqlParseQuery": {"start": "<int>", "end": "<int>"}}}

Queries

`sqlParseScript`

Description

Parses SQL script and returns script info with queries start and end positions

Response

Returns an SQLScriptInfo!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`script` - `String!`

Example

Query

query sqlParseScript(
  $projectId: ID,
  $connectionId: ID!,
  $script: String!
) {
  sqlParseScript(
    projectId: $projectId,
    connectionId: $connectionId,
    script: $script
  ) {
    queries {
      ...SQLScriptQueryFragment
    }
  }
}

Variables

{"projectId": "<id>", "connectionId": "<id>", "script": "<string>"}

Response

{
  "data": {
    "sqlParseScript": {"queries": [SQLScriptQuery]}
  }
}

Queries

`sqlResultAssociations`

Description

Foreign-key navigation metadata for the given result set. Set isReference to true for reverse references, false for forward associations, or omit it to get both

Response

Returns [SQLResultAssociation!]!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`isReference` - `Boolean`

Example

Query

query sqlResultAssociations(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $isReference: Boolean
) {
  sqlResultAssociations(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    isReference: $isReference
  ) {
    reference
    associationName
    targetCatalogName
    targetSchemaName
    targetEntityName
    targetNodePath
    columnMapping {
      ...SQLReferenceColumnMappingFragment
    }
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "isReference": "<boolean>"
}

Response

{
  "data": {
    "sqlResultAssociations": [
      {
        "reference": "<boolean>",
        "associationName": "<string>",
        "targetCatalogName": "<string>",
        "targetSchemaName": "<string>",
        "targetEntityName": "<string>",
        "targetNodePath": "<string>",
        "columnMapping": [SQLReferenceColumnMapping]
      }
    ]
  }
}

Queries

`sqlSupportedOperations`

Description

Returns suported operations for the specified attribute index in the results

Response

Returns [DataTypeLogicalOperation!]!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`attributeIndex` - `Int!`

Example

Query

query sqlSupportedOperations(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $attributeIndex: Int!
) {
  sqlSupportedOperations(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    attributeIndex: $attributeIndex
  ) {
    id
    expression
    argumentCount
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "attributeIndex": "<int>"
}

Response

{
  "data": {
    "sqlSupportedOperations": [
      {"id": "<id>", "expression": "<string>", "argumentCount": "<int>"}
    ]
  }
}

Mutations

`asyncReadDataFromContainer`

Description

Creates async task for reading data from the container node

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`containerNodePath` - `ID!`
`resultId` - `ID`
`filter` - `SQLDataFilter`
`dataFormat` - `ResultDataFormat`

Example

Query

mutation asyncReadDataFromContainer(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $containerNodePath: ID!,
  $resultId: ID,
  $filter: SQLDataFilter,
  $dataFormat: ResultDataFormat
) {
  asyncReadDataFromContainer(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    containerNodePath: $containerNodePath,
    resultId: $resultId,
    filter: $filter,
    dataFormat: $dataFormat
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "containerNodePath": "<id>",
  "resultId": "<id>",
  "filter": SQLDataFilter,
  "dataFormat": "resultset"
}

Response

{
  "data": {
    "asyncReadDataFromContainer": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncSqlCommitTransaction`

Description

Creates async task to commit transaction

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID!`
`connectionId` - `ID!`
`contextId` - `ID!`

Example

Query

mutation asyncSqlCommitTransaction(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!
) {
  asyncSqlCommitTransaction(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{"projectId": "<id>", "connectionId": "<id>", "contextId": "<id>"}

Response

{
  "data": {
    "asyncSqlCommitTransaction": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncSqlExecuteQuery`

Description

Creates async task for executing SQL query

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`sql` - `String!`
`resultId` - `ID`
`filter` - `SQLDataFilter`
`dataFormat` - `ResultDataFormat`
`readLogs` - `Boolean`
`isInteractive` - `Boolean`

Example

Query

mutation asyncSqlExecuteQuery(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $sql: String!,
  $resultId: ID,
  $filter: SQLDataFilter,
  $dataFormat: ResultDataFormat,
  $readLogs: Boolean,
  $isInteractive: Boolean
) {
  asyncSqlExecuteQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    sql: $sql,
    resultId: $resultId,
    filter: $filter,
    dataFormat: $dataFormat,
    readLogs: $readLogs,
    isInteractive: $isInteractive
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "sql": "<string>",
  "resultId": "<id>",
  "filter": SQLDataFilter,
  "dataFormat": "resultset",
  "readLogs": "<boolean>",
  "isInteractive": "<boolean>"
}

Response

{
  "data": {
    "asyncSqlExecuteQuery": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncSqlExecuteResults`

Description

Returns SQL execution results for async SQL execute task

Response

Returns an SQLExecuteInfo!

Arguments

Name	Description
`taskId` - `ID!`

Example

Query

mutation asyncSqlExecuteResults($taskId: ID!) {
  asyncSqlExecuteResults(taskId: $taskId) {
    statusMessage
    duration
    filterText
    fullQuery
    originalQuery
    results {
      ...SQLQueryResultsFragment
    }
  }
}

Variables

{"taskId": "<id>"}

Response

{
  "data": {
    "asyncSqlExecuteResults": {
      "statusMessage": "<string>",
      "duration": "<int>",
      "filterText": "<string>",
      "fullQuery": "<string>",
      "originalQuery": "<string>",
      "results": [SQLQueryResults]
    }
  }
}

Mutations

`asyncSqlExplainExecutionPlan`

Description

Creates async task to generating SQL execution plan

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`query` - `String!`
`configuration` - `Object!`

Example

Query

mutation asyncSqlExplainExecutionPlan(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!,
  $configuration: Object!
) {
  asyncSqlExplainExecutionPlan(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query,
    configuration: $configuration
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "query": "<string>",
  "configuration": "<object>"
}

Response

{
  "data": {
    "asyncSqlExplainExecutionPlan": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncSqlExplainExecutionPlanResult`

Description

Returns SQL execution plan for async SQL explain task

Response

Returns an SQLExecutionPlan!

Arguments

Name	Description
`taskId` - `ID!`

Example

Query

mutation asyncSqlExplainExecutionPlanResult($taskId: ID!) {
  asyncSqlExplainExecutionPlanResult(taskId: $taskId) {
    query
    nodes {
      ...SQLExecutionPlanNodeFragment
    }
    hasCost
    hasRows
    hasDuration
    durationMeasure
  }
}

Variables

{"taskId": "<id>"}

Response

{
  "data": {
    "asyncSqlExplainExecutionPlanResult": {
      "query": "<string>",
      "nodes": [SQLExecutionPlanNode],
      "hasCost": "<boolean>",
      "hasRows": "<boolean>",
      "hasDuration": "<boolean>",
      "durationMeasure": "<string>"
    }
  }
}

Mutations

`asyncSqlGenerateEntityQuery`

Description

Creates async task to generate entity SQL. Generated SQL is returned in the taskResult field

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`generatorId` - `String!`
`nodePathList` - `[String!]!`
`generatorOptions` - `SQLQueryGeneratorOptions`

Example

Query

mutation asyncSqlGenerateEntityQuery(
  $generatorId: String!,
  $nodePathList: [String!]!,
  $generatorOptions: SQLQueryGeneratorOptions
) {
  asyncSqlGenerateEntityQuery(
    generatorId: $generatorId,
    nodePathList: $nodePathList,
    generatorOptions: $generatorOptions
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "generatorId": "<string>",
  "nodePathList": "<string>",
  "generatorOptions": SQLQueryGeneratorOptions
}

Response

{
  "data": {
    "asyncSqlGenerateEntityQuery": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncSqlRollbackTransaction`

Description

Creates async task to rollback transaction

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID!`
`connectionId` - `ID!`
`contextId` - `ID!`

Example

Query

mutation asyncSqlRollbackTransaction(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!
) {
  asyncSqlRollbackTransaction(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{"projectId": "<id>", "connectionId": "<id>", "contextId": "<id>"}

Response

{
  "data": {
    "asyncSqlRollbackTransaction": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncSqlRowDataCount`

Description

Creates async task to count rows in SQL results

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`

Example

Query

mutation asyncSqlRowDataCount(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!
) {
  asyncSqlRowDataCount(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>"
}

Response

{
  "data": {
    "asyncSqlRowDataCount": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncSqlRowDataCountResult`

Description

Returns row count for async SQL row data count task

Response

Returns an Int!

Arguments

Name	Description
`taskId` - `ID!`

Example

Query

mutation asyncSqlRowDataCountResult($taskId: ID!) {
  asyncSqlRowDataCountResult(taskId: $taskId)
}

Variables

{"taskId": "<id>"}

Response

{
  "data": {
    "asyncSqlRowDataCountResult": "<int>"
  }
}

Mutations

`asyncSqlSetAutoCommit`

Description

Creates async task to set auto-commit mode

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID!`
`connectionId` - `ID!`
`contextId` - `ID!`
`autoCommit` - `Boolean!`

Example

Query

mutation asyncSqlSetAutoCommit(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!,
  $autoCommit: Boolean!
) {
  asyncSqlSetAutoCommit(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    autoCommit: $autoCommit
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "autoCommit": "<boolean>"
}

Response

{
  "data": {
    "asyncSqlSetAutoCommit": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`asyncUpdateResultsDataBatch`

Description

Creates async task for updating results data in batch mode

Response

Returns an AsyncTaskInfo!

Arguments

Name	Description
`projectId` - `ID!`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`updatedRows` - `[SQLResultRow!]`
`deletedRows` - `[SQLResultRow!]`
`addedRows` - `[SQLResultRow!]`

Example

Query

mutation asyncUpdateResultsDataBatch(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $updatedRows: [SQLResultRow!],
  $deletedRows: [SQLResultRow!],
  $addedRows: [SQLResultRow!]
) {
  asyncUpdateResultsDataBatch(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    updatedRows: $updatedRows,
    deletedRows: $deletedRows,
    addedRows: $addedRows
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "updatedRows": [SQLResultRow],
  "deletedRows": [SQLResultRow],
  "addedRows": [SQLResultRow]
}

Response

{
  "data": {
    "asyncUpdateResultsDataBatch": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}

Mutations

`getTransactionLogInfo`

Description

Returns transaction log info for the specified project, connection and context

Response

Returns a TransactionLogInfos!

Arguments

Name	Description
`projectId` - `ID!`
`connectionId` - `ID!`
`contextId` - `ID!`

Example

Query

mutation getTransactionLogInfo(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!
) {
  getTransactionLogInfo(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    count
    transactionLogInfos {
      ...TransactionLogInfoItemFragment
    }
  }
}

Variables

{"projectId": "<id>", "connectionId": "<id>", "contextId": "<id>"}

Response

{
  "data": {
    "getTransactionLogInfo": {
      "count": "<int>",
      "transactionLogInfos": [TransactionLogInfoItem]
    }
  }
}

Mutations

`readLobValue`

use sqlReadLobValue (23.3.3)

Description

Returns BLOB value

Response

Returns a String!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`lobColumnIndex` - `Int!`
`row` - `[SQLResultRow!]!`

Example

Query

mutation readLobValue(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $lobColumnIndex: Int!,
  $row: [SQLResultRow!]!
) {
  readLobValue(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    lobColumnIndex: $lobColumnIndex,
    row: $row
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "lobColumnIndex": "<int>",
  "row": [SQLResultRow]
}

Response

{"data": {"readLobValue": "<string>"}}

Mutations

`sqlContextCreate`

Description

Creates SQL context for the specified connection

Response

Returns an SQLContextInfo!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`defaultCatalog` - `String`
`defaultSchema` - `String`

Example

Query

mutation sqlContextCreate(
  $projectId: ID,
  $connectionId: ID!,
  $defaultCatalog: String,
  $defaultSchema: String
) {
  sqlContextCreate(
    projectId: $projectId,
    connectionId: $connectionId,
    defaultCatalog: $defaultCatalog,
    defaultSchema: $defaultSchema
  ) {
    id
    projectId
    connectionId
    autoCommit
    defaultCatalog
    defaultSchema
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "defaultCatalog": "<string>",
  "defaultSchema": "<string>"
}

Response

{
  "data": {
    "sqlContextCreate": {
      "id": "<id>",
      "projectId": "<id>",
      "connectionId": "<id>",
      "autoCommit": "<boolean>",
      "defaultCatalog": "<string>",
      "defaultSchema": "<string>"
    }
  }
}

Mutations

`sqlContextDestroy`

Description

Destroys SQL context and closes all results

Response

Returns a Boolean!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`

Example

Query

mutation sqlContextDestroy(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!
) {
  sqlContextDestroy(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  )
}

Variables

{"projectId": "<id>", "connectionId": "<id>", "contextId": "<id>"}

Response

{"data": {"sqlContextDestroy": "<boolean>"}}

Mutations

`sqlContextSetDefaults`

Description

Sets SQL context defaults

Response

Returns a Boolean!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`defaultCatalog` - `ID`
`defaultSchema` - `ID`

Example

Query

mutation sqlContextSetDefaults(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $defaultCatalog: ID,
  $defaultSchema: ID
) {
  sqlContextSetDefaults(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    defaultCatalog: $defaultCatalog,
    defaultSchema: $defaultSchema
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "defaultCatalog": "<id>",
  "defaultSchema": "<id>"
}

Response

{
  "data": {
    "sqlContextSetDefaults": "<boolean>"
  }
}

Mutations

`sqlGetDynamicTrace`

Description

Reads dynamic trace from provided database results

Response

Returns [DynamicTraceProperty!]!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`

Example

Query

mutation sqlGetDynamicTrace(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!
) {
  sqlGetDynamicTrace(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId
  ) {
    name
    value
    description
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>"
}

Response

{
  "data": {
    "sqlGetDynamicTrace": [
      {"name": "<string>", "value": "<string>", "description": "<string>"}
    ]
  }
}

Mutations

`sqlReadLobValue`

Description

Returns BLOB value as Base64 encoded string

Response

Returns a String!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`lobColumnIndex` - `Int!`
`row` - `SQLResultRow!`

Example

Query

mutation sqlReadLobValue(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $lobColumnIndex: Int!,
  $row: SQLResultRow!
) {
  sqlReadLobValue(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    lobColumnIndex: $lobColumnIndex,
    row: $row
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "lobColumnIndex": "<int>",
  "row": SQLResultRow
}

Response

{"data": {"sqlReadLobValue": "<string>"}}

Mutations

`sqlReadStringValue`

Description

Returns full string value ignoring any limits

Response

Returns a String!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`columnIndex` - `Int!`
`row` - `SQLResultRow!`

Example

Query

mutation sqlReadStringValue(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $columnIndex: Int!,
  $row: SQLResultRow!
) {
  sqlReadStringValue(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    columnIndex: $columnIndex,
    row: $row
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "columnIndex": "<int>",
  "row": SQLResultRow
}

Response

{"data": {"sqlReadStringValue": "<string>"}}

Mutations

`sqlResultClose`

Description

Closes SQL results (free resources)

Response

Returns a Boolean!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultId` - `ID!`

Example

Query

mutation sqlResultClose(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultId: ID!
) {
  sqlResultClose(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultId: $resultId
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultId": "<id>"
}

Response

{"data": {"sqlResultClose": "<boolean>"}}

Mutations

`updateResultsDataBatch`

use async function (25.0.0)

Description

Synchronously updates results data in batch mode

Response

Returns an SQLExecuteInfo!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`updatedRows` - `[SQLResultRow!]`
`deletedRows` - `[SQLResultRow!]`
`addedRows` - `[SQLResultRow!]`

Example

Query

mutation updateResultsDataBatch(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $updatedRows: [SQLResultRow!],
  $deletedRows: [SQLResultRow!],
  $addedRows: [SQLResultRow!]
) {
  updateResultsDataBatch(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    updatedRows: $updatedRows,
    deletedRows: $deletedRows,
    addedRows: $addedRows
  ) {
    statusMessage
    duration
    filterText
    fullQuery
    originalQuery
    results {
      ...SQLQueryResultsFragment
    }
  }
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "updatedRows": [SQLResultRow],
  "deletedRows": [SQLResultRow],
  "addedRows": [SQLResultRow]
}

Response

{
  "data": {
    "updateResultsDataBatch": {
      "statusMessage": "<string>",
      "duration": "<int>",
      "filterText": "<string>",
      "fullQuery": "<string>",
      "originalQuery": "<string>",
      "results": [SQLQueryResults]
    }
  }
}

Mutations

`updateResultsDataBatchScript`

Description

Returns SQL script for cell values update

Response

Returns a String!

Arguments

Name	Description
`projectId` - `ID`
`connectionId` - `ID!`
`contextId` - `ID!`
`resultsId` - `ID!`
`updatedRows` - `[SQLResultRow!]`
`deletedRows` - `[SQLResultRow!]`
`addedRows` - `[SQLResultRow!]`

Example

Query

mutation updateResultsDataBatchScript(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $updatedRows: [SQLResultRow!],
  $deletedRows: [SQLResultRow!],
  $addedRows: [SQLResultRow!]
) {
  updateResultsDataBatchScript(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    updatedRows: $updatedRows,
    deletedRows: $deletedRows,
    addedRows: $addedRows
  )
}

Variables

{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "updatedRows": [SQLResultRow],
  "deletedRows": [SQLResultRow],
  "addedRows": [SQLResultRow]
}

Response

{
  "data": {
    "updateResultsDataBatchScript": "<string>"
  }
}

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

Condition

Description

Represents a dynamic condition for a property, such as visibility or read-only state

Fields

Field Name	Description
`expression` - `String!`	The logical expression that defines when the condition applies
`conditionType` - `ConditionType!`	The type of condition (e.g., HIDE or READ_ONLY)

Example

{"expression": "<string>", "conditionType": "HIDE"}

Types

ConditionType

Values

Enum Value	Description
`HIDE`	hiding property condition
`READ_ONLY`	restriction for setting a property value

Example

"HIDE"

Types

DataTypeLogicalOperation

Fields

Field Name	Description
`id` - `ID!`
`expression` - `String!`
`argumentCount` - `Int`

Example

{"id": "<id>", "expression": "<string>", "argumentCount": "<int>"}

Types

DateTime

Description

Date/Time

Example

"<datetime>"

Types

DynamicTraceProperty

Fields

Field Name	Description
`name` - `String!`
`value` - `String`
`description` - `String`

Example

{"name": "<string>", "value": "<string>", "description": "<string>"}

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

ObjectPropertyInfo

Description

Information about the object property used to generate its UI

Fields

Field Name	Description
`id` - `String`	Unique property identifier
`displayName` - `String`	Human-readable name
`description` - `String`	Property description
`hint` - `String`	Usage hint for the property
`category` - `String`	Property category (may be used if object has a lot of properties)
`dataType` - `String`	Property data type (e.g., int, String)
`value` - `Object`	Property value (can be resource-intensive for some properties, e.g., RowCount for tables)
`validValues` - `[Object]`	List of allowed values (for enumerable properties)
`defaultValue` - `Object`	Default property value
`length` - `ObjectPropertyLength!`	Property value length
`features` - `[String!]!`	List of supported features (e.g., system, hidden, inherited, foreign, expensive)
`order` - `Int!`	Order position
`supportedConfigurationTypes` - `[String!]`	Supported configuration types (for driver properties)
`required` - `Boolean!`	Is the property required
`scopes` - `[String!]`	List of preference scopes (e.g., global, user)
`conditions` - `[Condition!]`	Dynamic conditions for the property (e.g., visibility or read-only)

Example

{
  "id": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "hint": "<string>",
  "category": "<string>",
  "dataType": "<string>",
  "value": "<object>",
  "validValues": ["<object>"],
  "defaultValue": "<object>",
  "length": "TINY",
  "features": ["<string>"],
  "order": "<int>",
  "supportedConfigurationTypes": ["<string>"],
  "required": "<boolean>",
  "scopes": ["<string>"],
  "conditions": [Condition]
}

Types

ObjectPropertyLength

Values

Enum Value	Description
`TINY`	1 character
`SHORT`	20 characters
`MEDIUM`	<= 64 characters
`LONG`	Full line length. The default
`MULTILINE`	Multi-line long text

Example

"TINY"

Types

ResultDataFormat

Values

Enum Value	Description
`resultset`
`document`
`graph`
`timeseries`

Example

"resultset"

Types

SQLCompletionProposal

Fields

Field Name	Description
`displayString` - `String!`
`type` - `String!`
`score` - `Int`
`replacementString` - `String!`
`replacementOffset` - `Int!`
`replacementLength` - `Int!`
`cursorPosition` - `Int`
`icon` - `String`
`nodePath` - `String`

Example

{
  "displayString": "<string>",
  "type": "<string>",
  "score": "<int>",
  "replacementString": "<string>",
  "replacementOffset": "<int>",
  "replacementLength": "<int>",
  "cursorPosition": "<int>",
  "icon": "<string>",
  "nodePath": "<string>"
}

Types

SQLContextInfo

Description

SQL context must be created for each SQL editor

Fields

Field Name	Description
`id` - `ID!`
`projectId` - `ID!`
`connectionId` - `ID!`
`autoCommit` - `Boolean`
`defaultCatalog` - `String`
`defaultSchema` - `String`

Example

{
  "id": "<id>",
  "projectId": "<id>",
  "connectionId": "<id>",
  "autoCommit": "<boolean>",
  "defaultCatalog": "<string>",
  "defaultSchema": "<string>"
}

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

SQLDialectInfo

Fields

Field Name	Description
`name` - `String!`
`dataTypes` - `[String]!`
`functions` - `[String]!`
`reservedWords` - `[String]!`
`quoteStrings` - `[String]!`
`singleLineComments` - `[String]!`
`multiLineComments` - `[String]!`
`catalogSeparator` - `String`
`structSeparator` - `String`
`scriptDelimiter` - `String`
`supportsExplainExecutionPlan` - `Boolean!`

Example

{
  "name": "<string>",
  "dataTypes": ["<string>"],
  "functions": ["<string>"],
  "reservedWords": ["<string>"],
  "quoteStrings": ["<string>"],
  "singleLineComments": ["<string>"],
  "multiLineComments": ["<string>"],
  "catalogSeparator": "<string>",
  "structSeparator": "<string>",
  "scriptDelimiter": "<string>",
  "supportsExplainExecutionPlan": "<boolean>"
}

Types

SQLExecuteInfo

Fields

Field Name	Description
`statusMessage` - `String`	Status message
`duration` - `Int!`	Execute time (ms)
`filterText` - `String`	Actual conditions applied to query
`fullQuery` - `String`	Full query that was executed, contains all used filters
`originalQuery` - `String`	Original query that was executed, without modifications
`results` - `[SQLQueryResults!]!`	Results

Example

{
  "statusMessage": "<string>",
  "duration": "<int>",
  "filterText": "<string>",
  "fullQuery": "<string>",
  "originalQuery": "<string>",
  "results": [SQLQueryResults]
}

Types

SQLExecutionPlan

Fields

Field Name	Description
`query` - `String!`
`nodes` - `[SQLExecutionPlanNode!]!`
`hasCost` - `Boolean!`
`hasRows` - `Boolean!`
`hasDuration` - `Boolean!`
`durationMeasure` - `String`

Example

{
  "query": "<string>",
  "nodes": [SQLExecutionPlanNode],
  "hasCost": "<boolean>",
  "hasRows": "<boolean>",
  "hasDuration": "<boolean>",
  "durationMeasure": "<string>"
}

Types

SQLExecutionPlanNode

Fields

Field Name	Description
`id` - `ID!`
`parentId` - `ID`
`kind` - `String!`
`name` - `String`
`type` - `String!`
`condition` - `String`
`description` - `String`
`properties` - `[ObjectPropertyInfo!]!`
`cost` - `Float`
`rowCount` - `Float`
`duration` - `Float`
`percent` - `Float`

Example

{
  "id": "<id>",
  "parentId": "<id>",
  "kind": "<string>",
  "name": "<string>",
  "type": "<string>",
  "condition": "<string>",
  "description": "<string>",
  "properties": [ObjectPropertyInfo],
  "cost": "<float>",
  "rowCount": "<float>",
  "duration": "<float>",
  "percent": "<float>"
}

Types

SQLQueryGenerator

Fields

Field Name	Description
`id` - `String!`
`label` - `String!`
`description` - `String`
`order` - `Int!`
`multiObject` - `Boolean!`

Example

{
  "id": "<string>",
  "label": "<string>",
  "description": "<string>",
  "order": "<int>",
  "multiObject": "<boolean>"
}

Types

SQLQueryGeneratorOptions

Fields

Input Field	Description
`useFullyQualifiedNames` - `Boolean!`
`compactSql` - `Boolean!`
`showFullDdl` - `Boolean`	Include nested objects, comments and permissions in generated DDL (since 26.0.4)

Example

{
  "useFullyQualifiedNames": "<boolean>",
  "compactSql": "<boolean>",
  "showFullDdl": "<boolean>"
}

Types

SQLQueryResults

Fields

Field Name	Description
`title` - `String`
`updateRowCount` - `Float`
`sourceQuery` - `String`
`dataFormat` - `ResultDataFormat`	Actual data format of this result
`resultSet` - `SQLResultSet`

Example

{
  "title": "<string>",
  "updateRowCount": "<float>",
  "sourceQuery": "<string>",
  "dataFormat": "resultset",
  "resultSet": SQLResultSet
}

Types

SQLReferenceColumnMapping

Description

Pair (source-row column index, target-entity column name) used to build a navigation filter

Fields

Field Name	Description
`sourceColumnIndex` - `Int!`	Position in the result-set bindings
`sourceColumnName` - `String!`	Column name in the source result set
`targetColumnIndex` - `Int!`	Ordinal position of the column in the target entity definition
`targetColumnName` - `String!`	Column name in the target entity

Example

{
  "sourceColumnIndex": "<int>",
  "sourceColumnName": "<string>",
  "targetColumnIndex": "<int>",
  "targetColumnName": "<string>"
}

Types

SQLResultAssociation

Fields

Field Name	Description
`reference` - `Boolean!`	True for reverse references (incoming FKs)
`associationName` - `String!`	Name of the association (foreign key)
`targetCatalogName` - `String`	Name of the catalog the target entity belongs to
`targetSchemaName` - `String`	Name of the schema the target entity belongs to
`targetEntityName` - `String`	Plain name of the target entity
`targetNodePath` - `String`	Navigator node URI of the target entity, suitable for opening it directly in the UI. Null if the entity is not present in the navigator tree
`columnMapping` - `[SQLReferenceColumnMapping!]!`	List of column mappings between the source result set and the target entity

Example

{
  "reference": "<boolean>",
  "associationName": "<string>",
  "targetCatalogName": "<string>",
  "targetSchemaName": "<string>",
  "targetEntityName": "<string>",
  "targetNodePath": "<string>",
  "columnMapping": [SQLReferenceColumnMapping]
}

Types

SQLResultColumn

Fields

Field Name	Description
`position` - `Int!`
`name` - `String`
`label` - `String`
`icon` - `String`
`entityName` - `String`
`dataKind` - `String`
`typeName` - `String`
`fullTypeName` - `String`
`maxLength` - `Float`	Column value max length. We use Float because it may be bigger than 32 bit
`scale` - `Int`
`precision` - `Int`
`required` - `Boolean!`
`autoGenerated` - `Boolean!`
`readOnly` - `Boolean!`
`readOnlyStatus` - `String`
`supportedOperations` - `[DataTypeLogicalOperation!]!`	Operations supported for this attribute
`description` - `String`	Description of the column

Example

{
  "position": "<int>",
  "name": "<string>",
  "label": "<string>",
  "icon": "<string>",
  "entityName": "<string>",
  "dataKind": "<string>",
  "typeName": "<string>",
  "fullTypeName": "<string>",
  "maxLength": "<float>",
  "scale": "<int>",
  "precision": "<int>",
  "required": "<boolean>",
  "autoGenerated": "<boolean>",
  "readOnly": "<boolean>",
  "readOnlyStatus": "<string>",
  "supportedOperations": [DataTypeLogicalOperation],
  "description": "<string>"
}

Types

SQLResultRow

Fields

Input Field	Description
`data` - `[Object]!`
`updateValues` - `Object`
`metaData` - `Object`

Example

{"data": ["<object>"], "updateValues": "<object>", "metaData": "<object>"}

Types

SQLResultRowMetaData

Fields

Field Name	Description
`data` - `[Object]!`
`metaData` - `Object`

Example

{"data": ["<object>"], "metaData": "<object>"}

Types

SQLResultSet

Fields

Field Name	Description
`id` - `ID!`	Result set ID
`columns` - `[SQLResultColumn]`	Returns list of columns in the result set
`rows` - `[Object]`	Returns list of rows in the result set. Each row is an array of column values use rowsWithMetaData (23.3.5)
`rowsWithMetaData` - `[SQLResultRowMetaData]`	Returns list of rows in the result set. Each row contains data and metadata
`singleEntity` - `Boolean!`	True means that resultset was generated by single entity query New rows can be added, old rows can be deleted
`hasMoreData` - `Boolean!`	server always returns hasMoreData = false
`hasRowIdentifier` - `Boolean!`	Identifies if result set has row identifier. If true then it is possible update data or load LOB files use rowIdentifierState (25.3.4)
`rowIdentifierState` - `SQLRowIdentifierState`	State of a table row identifier: METADATA_NOT_FOUND, NONE, PRIMARY_KEY, VIRTUAL_KEY
`rowIdentifier` - `SQLRowIdentifier`	Contains info about a result set row identifier. Present if rowIdentifierState is PRIMARY_KEY
`hasChildrenCollection` - `Boolean!`	Identifies if result has children collections. If true then children collections can be read from the result set
`hasDynamicTrace` - `Boolean!`	Identifies if result set supports dynamic trace. If true then dynamic trace can be read from the result set
`isSupportsDataFilter` - `Boolean!`	Identifies if result set supports data filter. If true then data filter can be applied to the result set
`readOnly` - `Boolean!`	Identifies if result set is read-only. If true then no updates are allowed
`readOnlyStatus` - `String`	Status of read-only result set. If readOnly is true then this field contains reason why result set is read-only

Example

{
  "id": "<id>",
  "columns": [SQLResultColumn],
  "rows": ["<object>"],
  "rowsWithMetaData": [SQLResultRowMetaData],
  "singleEntity": "<boolean>",
  "hasMoreData": "<boolean>",
  "hasRowIdentifier": "<boolean>",
  "rowIdentifierState": "METADATA_NOT_FOUND",
  "rowIdentifier": SQLRowIdentifier,
  "hasChildrenCollection": "<boolean>",
  "hasDynamicTrace": "<boolean>",
  "isSupportsDataFilter": "<boolean>",
  "readOnly": "<boolean>",
  "readOnlyStatus": "<string>"
}

Types

SQLResultSetGeneratorId

Values

Enum Value	Description
`dataSelect`	SELECT .. WHERE .. =
`dataSelectMany`	SELECT .. WHERE .. IN
`dataInsert`	INSERT
`dataUpdate`	UPDATE
`dataDeleteByUniqueKey`	DELETE by Unique Key

Example

"dataSelect"

Types

SQLRowIdentifier

Fields

Field Name	Description
`attributes` - `[SQLRowIdentifierAttribute!]!`	Single or multiple attributes acting as a row identifier
`constraintType` - `String!`	Type of a row identifier constraint

Example

{
  "attributes": [SQLRowIdentifierAttribute],
  "constraintType": "<string>"
}

Types

SQLRowIdentifierAttribute

Fields

Field Name	Description
`name` - `String!`
`ordinalPosition` - `Int!`

Example

{"name": "<string>", "ordinalPosition": "<int>"}

Types

SQLRowIdentifierState

Values

Enum Value	Description
`METADATA_NOT_FOUND`
`NONE`
`PRIMARY_KEY`
`VIRTUAL_KEY`

Example

"METADATA_NOT_FOUND"

Types

SQLScriptInfo

Fields

Field Name	Description
`queries` - `[SQLScriptQuery!]!`

Example

{"queries": [SQLScriptQuery]}

Types

SQLScriptQuery

Fields

Field Name	Description
`start` - `Int!`
`end` - `Int!`

Example

{"start": "<int>", "end": "<int>"}

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

Types

TransactionLogInfoItem

Fields

Field Name	Description
`id` - `Int!`
`time` - `DateTime!`
`type` - `String!`
`queryString` - `String!`
`durationMs` - `Int!`
`rows` - `Int!`
`result` - `String!`

Example

{
  "id": "<int>",
  "time": "<datetime>",
  "type": "<string>",
  "queryString": "<string>",
  "durationMs": "<int>",
  "rows": "<int>",
  "result": "<string>"
}

Types

TransactionLogInfos

Fields

Field Name	Description
`count` - `Int!`
`transactionLogInfos` - `[TransactionLogInfoItem!]!`

Example

{
  "count": "<int>",
  "transactionLogInfos": [TransactionLogInfoItem]
}

Documentation by Anvil SpectaQL

See DBeaver in action

Choose your product

SQL helpers schema

API Endpoints

Queries

asyncSqlGroupingResultSet

Description

Response

Arguments

Example

Query

Variables

Response

sqlCompletionProposals

Description

Response

Arguments

Example

Query

Variables

Response

sqlDialectInfo

Description

Response

Arguments

Example

Query

Variables

Response

sqlEntityQueryGenerators

Description

Response

Arguments

Example

Query

Variables

Response

sqlFormatQuery

Description

Response

Arguments

Example

Query

Variables

Response

sqlGenerateEntityQuery

Description

Response

Arguments

Example

Query

Variables

Response

sqlGenerateGroupingQuery

Description

Response

Arguments

Example

Query

Variables

Response

sqlGenerateResultSetQuery

Description

Response

Arguments

Example

Query

Variables

Response

sqlListContexts

Description

Response

Arguments

Example

Query

Variables

Response

sqlParseQuery

Description

Response

`asyncSqlGroupingResultSet`

`sqlCompletionProposals`

`sqlDialectInfo`

`sqlEntityQueryGenerators`

`sqlFormatQuery`

`sqlGenerateEntityQuery`

`sqlGenerateGroupingQuery`

`sqlGenerateResultSetQuery`

`sqlListContexts`

`sqlParseQuery`

`sqlParseScript`

`sqlResultAssociations`

`sqlSupportedOperations`

`asyncReadDataFromContainer`

`asyncSqlCommitTransaction`

`asyncSqlExecuteQuery`