Data transfer queries schema

service.data.transfer.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

dataTransferAvailableImportStreamProcessors

Description

Returns available transfer processors for data transfer import

Response

Returns [DataTransferProcessorInfo!]!

Example

Query
query dataTransferAvailableImportStreamProcessors {
  dataTransferAvailableImportStreamProcessors {
    id
    name
    description
    fileExtension
    appFileExtension
    appName
    order
    icon
    properties {
      ...ObjectPropertyInfoFragment
    }
    isBinary
    isHTML
  }
}
Response
{
  "data": {
    "dataTransferAvailableImportStreamProcessors": [
      {
        "id": "<id>",
        "name": "<string>",
        "description": "<string>",
        "fileExtension": "<string>",
        "appFileExtension": "<string>",
        "appName": "<string>",
        "order": "<int>",
        "icon": "<string>",
        "properties": [ObjectPropertyInfo],
        "isBinary": "<boolean>",
        "isHTML": "<boolean>"
      }
    ]
  }
}
Queries

dataTransferAvailableStreamProcessors

Description

Returns available transfer processors for data transfer export

Response

Returns [DataTransferProcessorInfo!]!

Example

Query
query dataTransferAvailableStreamProcessors {
  dataTransferAvailableStreamProcessors {
    id
    name
    description
    fileExtension
    appFileExtension
    appName
    order
    icon
    properties {
      ...ObjectPropertyInfoFragment
    }
    isBinary
    isHTML
  }
}
Response
{
  "data": {
    "dataTransferAvailableStreamProcessors": [
      {
        "id": "<id>",
        "name": "<string>",
        "description": "<string>",
        "fileExtension": "<string>",
        "appFileExtension": "<string>",
        "appName": "<string>",
        "order": "<int>",
        "icon": "<string>",
        "properties": [ObjectPropertyInfo],
        "isBinary": "<boolean>",
        "isHTML": "<boolean>"
      }
    ]
  }
}
Queries

dataTransferDefaultExportSettings

Description

Returns default export settings for data transfer

Response

Returns a DataTransferDefaultExportSettings!

Example

Query
query dataTransferDefaultExportSettings {
  dataTransferDefaultExportSettings {
    outputSettings {
      ...DataTransferOutputSettingsFragment
    }
    supportedEncodings
  }
}
Response
{
  "data": {
    "dataTransferDefaultExportSettings": {
      "outputSettings": DataTransferOutputSettings,
      "supportedEncodings": ["<string>"]
    }
  }
}
Queries

dataTransferExportDataFromContainer

Description

Creates async task for data transfer export from the container node path

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
containerNodePath - ID!
parameters - DataTransferParameters!

Example

Query
query dataTransferExportDataFromContainer(
  $projectId: ID,
  $connectionId: ID!,
  $containerNodePath: ID!,
  $parameters: DataTransferParameters!
) {
  dataTransferExportDataFromContainer(
    projectId: $projectId,
    connectionId: $connectionId,
    containerNodePath: $containerNodePath,
    parameters: $parameters
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "<id>",
  "connectionId": "<id>",
  "containerNodePath": "<id>",
  "parameters": DataTransferParameters
}
Response
{
  "data": {
    "dataTransferExportDataFromContainer": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}
Queries

dataTransferExportDataFromResults

Description

Creates async task for data transfer export from results

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
parameters - DataTransferParameters!

Example

Query
query dataTransferExportDataFromResults(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $parameters: DataTransferParameters!
) {
  dataTransferExportDataFromResults(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    parameters: $parameters
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "parameters": DataTransferParameters
}
Response
{
  "data": {
    "dataTransferExportDataFromResults": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}
Queries

dataTransferImportDataIntoResults

Description

Creates async task for data transfer import of a previously uploaded file into the results

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
parameters - DataTransferImportParameters!

Example

Query
query dataTransferImportDataIntoResults(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $parameters: DataTransferImportParameters!
) {
  dataTransferImportDataIntoResults(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    parameters: $parameters
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "resultsId": "<id>",
  "parameters": DataTransferImportParameters
}
Response
{
  "data": {
    "dataTransferImportDataIntoResults": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}
Queries

dataTransferRemoveDataFile

25.0.1
Description

Deletes data transfer file by ID

Response

Returns a Boolean

Arguments
Name Description
dataFileId - String!

Example

Query
query dataTransferRemoveDataFile($dataFileId: String!) {
  dataTransferRemoveDataFile(dataFileId: $dataFileId)
}
Variables
{"dataFileId": "<string>"}
Response
{
  "data": {
    "dataTransferRemoveDataFile": "<boolean>"
  }
}

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

DataTransferDefaultExportSettings

Fields
Field Name Description
outputSettings - DataTransferOutputSettings!
supportedEncodings - [String!]!
Example
{
  "outputSettings": DataTransferOutputSettings,
  "supportedEncodings": ["<string>"]
}
Types

DataTransferImportParameters

Fields
Input Field Description
processorId - ID! Import processor ID
settings - DataTransferImportSettings Import settings. Omitted settings keep their default value
Example
{
  "processorId": "<id>",
  "settings": DataTransferImportSettings
}
Types

DataTransferImportSettings

Description

Database dependent data import settings. Which of them are supported by a particular connection is reported by ConnectionInfo.driverConfiguration. New database dependent import settings should be added here.

Fields
Input Field Description
onDuplicateKeyMethod - ID Id of the 'on duplicate key' replace method
useBulkLoad - Boolean Use bulk load during import
useTransactions - Boolean Use transactions during import
Example
{
  "onDuplicateKeyMethod": "<id>",
  "useBulkLoad": "<boolean>",
  "useTransactions": "<boolean>"
}
Types

DataTransferOutputSettings

Fields
Field Name Description
insertBom - Boolean!
encoding - String!
timestampPattern - String!
compress - Boolean!
Example
{
  "insertBom": "<boolean>",
  "encoding": "<string>",
  "timestampPattern": "<string>",
  "compress": "<boolean>"
}
Types

DataTransferOutputSettingsInput

Fields
Input Field Description
insertBom - Boolean
encoding - String
timestampPattern - String
compress - Boolean
fileName - String
Example
{
  "insertBom": "<boolean>",
  "encoding": "<string>",
  "timestampPattern": "<string>",
  "compress": "<boolean>",
  "fileName": "<string>"
}
Types

DataTransferParameters

Fields
Input Field Description
processorId - ID! Processor ID
settings - Object

General settings:

  • openNewConnection: opens new database connection for data transfer task
processorProperties - Object! Processor properties. See DataTransferProcessorInfo.properties
outputSettings - DataTransferOutputSettingsInput Consumer properties. See StreamConsumerSettings
filter - SQLDataFilter Data filter settings
Example
{
  "processorId": "<id>",
  "settings": "<object>",
  "processorProperties": "<object>",
  "outputSettings": DataTransferOutputSettingsInput,
  "filter": SQLDataFilter
}
Types

DataTransferProcessorInfo

Fields
Field Name Description
id - ID!
name - String
description - String
fileExtension - String
appFileExtension - String
appName - String
order - Int!
icon - String
properties - [ObjectPropertyInfo]
isBinary - Boolean
isHTML - Boolean
Example
{
  "id": "<id>",
  "name": "<string>",
  "description": "<string>",
  "fileExtension": "<string>",
  "appFileExtension": "<string>",
  "appName": "<string>",
  "order": "<int>",
  "icon": "<string>",
  "properties": [ObjectPropertyInfo],
  "isBinary": "<boolean>",
  "isHTML": "<boolean>"
}
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

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

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