Data Transfer API, REST: Transfer.Get
- HTTP request
- Path parameters
- Response
- Endpoint
- EndpointSettings
- MysqlSource
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- ConnectionManagerConnection
- Secret
- MysqlObjectTransferSettings
- PostgresSource
- PostgresConnection
- OnPremisePostgres
- PostgresObjectTransferSettings
- YdbSource
- YDSSource
- Parser
- GenericParserCommon
- DataSchema
- FieldList
- ColSchema
- KafkaSource
- KafkaConnectionOptions
- OnPremiseKafka
- KafkaAuth
- KafkaSaslSecurity
- DataTransformationOptions
- MongoSource
- MongoConnection
- MongoConnectionOptions
- OnPremiseMongo
- MongoConnectionManagerConnection
- MongoCollection
- ClickhouseSource
- ClickhouseConnection
- ClickhouseConnectionOptions
- OnPremiseClickhouse
- ClickhouseShard
- MysqlTarget
- PostgresTarget
- ClickhouseTarget
- AltName
- ClickhouseSharding
- ColumnValueHash
- ColumnValueMapping
- ValueToShard
- ColumnValue
- YdbTarget
- KafkaTarget
- KafkaTargetTopicSettings
- KafkaTargetTopic
- Serializer
- SerializerDebezium
- DebeziumSerializerParameter
- MongoTarget
- MetrikaSource
- MetrikaStream
- YDSTarget
- Runtime
- YcRuntime
- ShardingUploadParams
- Transformation
- Transformer
- MaskFieldTransformer
- TablesFilter
- MaskFunction
- MaskFunctionHash
- FilterColumnsTransformer
- ColumnsFilter
- RenameTablesTransformer
- RenameTable
- Table
- ReplacePrimaryKeyTransformer
- ToStringTransformer
- SharderTransformer
- TableSplitterTransformer
- FilterRowsTransformer
- DataObjects
Returns the specified transfer.
To get the list of all available transfers, make a List request.
HTTP request
GET https://datatransfer.api.yandexcloud.kz/v1/transfer/{transferId}
Path parameters
|
Field |
Description |
|
transferId |
string Required field. Identifier of the transfer to be returned. To get the list of all available transfers, make a List request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"source": {
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"settings": {
// Includes only one of the fields `mysqlSource`, `postgresSource`, `ydbSource`, `ydsSource`, `kafkaSource`, `mongoSource`, `clickhouseSource`, `mysqlTarget`, `postgresTarget`, `clickhouseTarget`, `ydbTarget`, `kafkaTarget`, `mongoTarget`, `metrikaSource`, `ydsTarget`
"mysqlSource": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"timezone": "string",
"objectTransferSettings": {
"view": "string",
"routine": "string",
"trigger": "string",
"tables": "string"
},
"includeTablesRegex": [
"string"
],
"excludeTablesRegex": [
"string"
],
"securityGroups": [
"string"
],
"serviceDatabase": "string"
},
"postgresSource": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"includeTables": [
"string"
],
"excludeTables": [
"string"
],
"slotByteLagLimit": "string",
"serviceSchema": "string",
"objectTransferSettings": {
"sequence": "string",
"sequenceOwnedBy": "string",
"table": "string",
"primaryKey": "string",
"fkConstraint": "string",
"defaultValues": "string",
"constraint": "string",
"index": "string",
"view": "string",
"function": "string",
"trigger": "string",
"type": "string",
"rule": "string",
"collation": "string",
"policy": "string",
"cast": "string",
"materializedView": "string",
"sequenceSet": "string"
},
"securityGroups": [
"string"
]
},
"ydbSource": {
"database": "string",
"instance": "string",
"paths": [
"string"
],
"serviceAccountId": "string",
"subnetId": "string",
"saKeyContent": "string",
"securityGroups": [
"string"
],
"changefeedCustomName": "string",
"changefeedCustomConsumerName": "string"
},
"ydsSource": {
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"supportedCodecs": [
"string"
],
"parser": {
// Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
"jsonParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
},
"auditTrailsV1Parser": "object",
"cloudLoggingParser": "object",
"tskvParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
}
// end of the list of possible fields
},
"allowTtlRewind": "boolean",
"endpoint": "string",
"subnetId": "string",
"securityGroups": [
"string"
],
"consumer": "string"
},
"kafkaSource": {
"connection": {
// Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
"clusterId": "string",
"onPremise": {
"brokerUrls": [
"string"
],
"subnetId": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"auth": {
// Includes only one of the fields `sasl`, `noAuth`
"sasl": {
"user": "string",
"mechanism": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
}
},
"noAuth": "object"
// end of the list of possible fields
},
"securityGroups": [
"string"
],
"topicName": "string",
"transformer": {
"cloudFunction": "string",
"numberOfRetries": "string",
"bufferSize": "string",
"bufferFlushInterval": "string",
"invocationTimeout": "string",
"serviceAccountId": "string"
},
"parser": {
// Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
"jsonParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
},
"auditTrailsV1Parser": "object",
"cloudLoggingParser": "object",
"tskvParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
}
// end of the list of possible fields
},
"topicNames": [
"string"
]
},
"mongoSource": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"hosts": [
"string"
],
"port": "string",
"replicaSet": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"replicaSet": "string"
},
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"authSource": "string"
}
// end of the list of possible fields
},
"subnetId": "string",
"collections": [
{
"databaseName": "string",
"collectionName": "string"
}
],
"excludedCollections": [
{
"databaseName": "string",
"collectionName": "string"
}
],
"secondaryPreferredMode": "boolean",
"securityGroups": [
"string"
]
},
"clickhouseSource": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
"onPremise": {
"shards": [
{
"name": "string",
"hosts": [
"string"
]
}
],
"httpPort": "string",
"nativePort": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
},
"mdbClusterId": "string",
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"database": "string"
}
// end of the list of possible fields
},
"includeTables": [
"string"
],
"excludeTables": [
"string"
],
"subnetId": "string",
"securityGroups": [
"string"
],
"clickhouseClusterName": "string"
},
"mysqlTarget": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"sqlMode": "string",
"skipConstraintChecks": "boolean",
"timezone": "string",
"cleanupPolicy": "string",
"serviceDatabase": "string",
"securityGroups": [
"string"
],
"isSchemaMigrationDisabled": "boolean"
},
"postgresTarget": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"cleanupPolicy": "string",
"securityGroups": [
"string"
],
"isSchemaMigrationDisabled": "boolean"
},
"clickhouseTarget": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
"onPremise": {
"shards": [
{
"name": "string",
"hosts": [
"string"
]
}
],
"httpPort": "string",
"nativePort": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
},
"mdbClusterId": "string",
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"database": "string"
}
// end of the list of possible fields
},
"subnetId": "string",
"altNames": [
{
"fromName": "string",
"toName": "string"
}
],
"cleanupPolicy": "string",
"sharding": {
// Includes only one of the fields `columnValueHash`, `customMapping`
"columnValueHash": {
"columnName": "string"
},
"customMapping": {
"columnName": "string",
"mapping": [
{
"columnValue": {
// Includes only one of the fields `stringValue`
"stringValue": "string"
// end of the list of possible fields
},
"shardName": "string"
}
]
}
// end of the list of possible fields
},
"isSchemaMigrationDisabled": "boolean",
"clickhouseClusterName": "string",
"securityGroups": [
"string"
]
},
"ydbTarget": {
"database": "string",
"instance": "string",
"path": "string",
"serviceAccountId": "string",
"cleanupPolicy": "string",
"subnetId": "string",
"saKeyContent": "string",
"securityGroups": [
"string"
],
"isTableColumnOriented": "boolean",
"defaultCompression": "string",
"isSchemaMigrationDisabled": "boolean"
},
"kafkaTarget": {
"connection": {
// Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
"clusterId": "string",
"onPremise": {
"brokerUrls": [
"string"
],
"subnetId": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"auth": {
// Includes only one of the fields `sasl`, `noAuth`
"sasl": {
"user": "string",
"mechanism": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
}
},
"noAuth": "object"
// end of the list of possible fields
},
"securityGroups": [
"string"
],
"topicSettings": {
// Includes only one of the fields `topic`, `topicPrefix`
"topic": {
"topicName": "string",
"saveTxOrder": "boolean"
},
"topicPrefix": "string"
// end of the list of possible fields
},
"serializer": {
// Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
"serializerAuto": "object",
"serializerJson": "object",
"serializerDebezium": {
"serializerParameters": [
{
"key": "string",
"value": "string"
}
]
}
// end of the list of possible fields
}
},
"mongoTarget": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"hosts": [
"string"
],
"port": "string",
"replicaSet": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"replicaSet": "string"
},
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"authSource": "string"
}
// end of the list of possible fields
},
"database": "string",
"cleanupPolicy": "string",
"subnetId": "string",
"securityGroups": [
"string"
]
},
"metrikaSource": {
"counterIds": [
"string"
],
"token": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"streams": [
{
"type": "string",
"columns": [
"string"
]
}
]
},
"ydsTarget": {
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"saveTxOrder": "boolean",
"compressionCodec": "string",
"serializer": {
// Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
"serializerAuto": "object",
"serializerJson": "object",
"serializerDebezium": {
"serializerParameters": [
{
"key": "string",
"value": "string"
}
]
}
// end of the list of possible fields
},
"endpoint": "string",
"subnetId": "string",
"securityGroups": [
"string"
]
}
// end of the list of possible fields
}
},
"target": {
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"settings": {
// Includes only one of the fields `mysqlSource`, `postgresSource`, `ydbSource`, `ydsSource`, `kafkaSource`, `mongoSource`, `clickhouseSource`, `mysqlTarget`, `postgresTarget`, `clickhouseTarget`, `ydbTarget`, `kafkaTarget`, `mongoTarget`, `metrikaSource`, `ydsTarget`
"mysqlSource": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"timezone": "string",
"objectTransferSettings": {
"view": "string",
"routine": "string",
"trigger": "string",
"tables": "string"
},
"includeTablesRegex": [
"string"
],
"excludeTablesRegex": [
"string"
],
"securityGroups": [
"string"
],
"serviceDatabase": "string"
},
"postgresSource": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"includeTables": [
"string"
],
"excludeTables": [
"string"
],
"slotByteLagLimit": "string",
"serviceSchema": "string",
"objectTransferSettings": {
"sequence": "string",
"sequenceOwnedBy": "string",
"table": "string",
"primaryKey": "string",
"fkConstraint": "string",
"defaultValues": "string",
"constraint": "string",
"index": "string",
"view": "string",
"function": "string",
"trigger": "string",
"type": "string",
"rule": "string",
"collation": "string",
"policy": "string",
"cast": "string",
"materializedView": "string",
"sequenceSet": "string"
},
"securityGroups": [
"string"
]
},
"ydbSource": {
"database": "string",
"instance": "string",
"paths": [
"string"
],
"serviceAccountId": "string",
"subnetId": "string",
"saKeyContent": "string",
"securityGroups": [
"string"
],
"changefeedCustomName": "string",
"changefeedCustomConsumerName": "string"
},
"ydsSource": {
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"supportedCodecs": [
"string"
],
"parser": {
// Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
"jsonParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
},
"auditTrailsV1Parser": "object",
"cloudLoggingParser": "object",
"tskvParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
}
// end of the list of possible fields
},
"allowTtlRewind": "boolean",
"endpoint": "string",
"subnetId": "string",
"securityGroups": [
"string"
],
"consumer": "string"
},
"kafkaSource": {
"connection": {
// Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
"clusterId": "string",
"onPremise": {
"brokerUrls": [
"string"
],
"subnetId": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"auth": {
// Includes only one of the fields `sasl`, `noAuth`
"sasl": {
"user": "string",
"mechanism": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
}
},
"noAuth": "object"
// end of the list of possible fields
},
"securityGroups": [
"string"
],
"topicName": "string",
"transformer": {
"cloudFunction": "string",
"numberOfRetries": "string",
"bufferSize": "string",
"bufferFlushInterval": "string",
"invocationTimeout": "string",
"serviceAccountId": "string"
},
"parser": {
// Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
"jsonParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
},
"auditTrailsV1Parser": "object",
"cloudLoggingParser": "object",
"tskvParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "string",
"key": "boolean",
"required": "boolean",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "boolean",
"addRestColumn": "boolean",
"unescapeStringValues": "boolean"
}
// end of the list of possible fields
},
"topicNames": [
"string"
]
},
"mongoSource": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"hosts": [
"string"
],
"port": "string",
"replicaSet": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"replicaSet": "string"
},
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"authSource": "string"
}
// end of the list of possible fields
},
"subnetId": "string",
"collections": [
{
"databaseName": "string",
"collectionName": "string"
}
],
"excludedCollections": [
{
"databaseName": "string",
"collectionName": "string"
}
],
"secondaryPreferredMode": "boolean",
"securityGroups": [
"string"
]
},
"clickhouseSource": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
"onPremise": {
"shards": [
{
"name": "string",
"hosts": [
"string"
]
}
],
"httpPort": "string",
"nativePort": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
},
"mdbClusterId": "string",
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"database": "string"
}
// end of the list of possible fields
},
"includeTables": [
"string"
],
"excludeTables": [
"string"
],
"subnetId": "string",
"securityGroups": [
"string"
],
"clickhouseClusterName": "string"
},
"mysqlTarget": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"sqlMode": "string",
"skipConstraintChecks": "boolean",
"timezone": "string",
"cleanupPolicy": "string",
"serviceDatabase": "string",
"securityGroups": [
"string"
],
"isSchemaMigrationDisabled": "boolean"
},
"postgresTarget": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"port": "string",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"database": "string",
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"cleanupPolicy": "string",
"securityGroups": [
"string"
],
"isSchemaMigrationDisabled": "boolean"
},
"clickhouseTarget": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
"onPremise": {
"shards": [
{
"name": "string",
"hosts": [
"string"
]
}
],
"httpPort": "string",
"nativePort": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
},
"mdbClusterId": "string",
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"database": "string"
}
// end of the list of possible fields
},
"subnetId": "string",
"altNames": [
{
"fromName": "string",
"toName": "string"
}
],
"cleanupPolicy": "string",
"sharding": {
// Includes only one of the fields `columnValueHash`, `customMapping`
"columnValueHash": {
"columnName": "string"
},
"customMapping": {
"columnName": "string",
"mapping": [
{
"columnValue": {
// Includes only one of the fields `stringValue`
"stringValue": "string"
// end of the list of possible fields
},
"shardName": "string"
}
]
}
// end of the list of possible fields
},
"isSchemaMigrationDisabled": "boolean",
"clickhouseClusterName": "string",
"securityGroups": [
"string"
]
},
"ydbTarget": {
"database": "string",
"instance": "string",
"path": "string",
"serviceAccountId": "string",
"cleanupPolicy": "string",
"subnetId": "string",
"saKeyContent": "string",
"securityGroups": [
"string"
],
"isTableColumnOriented": "boolean",
"defaultCompression": "string",
"isSchemaMigrationDisabled": "boolean"
},
"kafkaTarget": {
"connection": {
// Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
"clusterId": "string",
"onPremise": {
"brokerUrls": [
"string"
],
"subnetId": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"subnetId": "string"
}
// end of the list of possible fields
},
"auth": {
// Includes only one of the fields `sasl`, `noAuth`
"sasl": {
"user": "string",
"mechanism": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
}
},
"noAuth": "object"
// end of the list of possible fields
},
"securityGroups": [
"string"
],
"topicSettings": {
// Includes only one of the fields `topic`, `topicPrefix`
"topic": {
"topicName": "string",
"saveTxOrder": "boolean"
},
"topicPrefix": "string"
// end of the list of possible fields
},
"serializer": {
// Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
"serializerAuto": "object",
"serializerJson": "object",
"serializerDebezium": {
"serializerParameters": [
{
"key": "string",
"value": "string"
}
]
}
// end of the list of possible fields
}
},
"mongoTarget": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
"mdbClusterId": "string",
"onPremise": {
"hosts": [
"string"
],
"port": "string",
"replicaSet": "string",
"tlsMode": {
// Includes only one of the fields `enabled`
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"connectionManagerConnection": {
"connectionId": "string",
"replicaSet": "string"
},
// end of the list of possible fields
"user": "string",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"authSource": "string"
}
// end of the list of possible fields
},
"database": "string",
"cleanupPolicy": "string",
"subnetId": "string",
"securityGroups": [
"string"
]
},
"metrikaSource": {
"counterIds": [
"string"
],
"token": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"streams": [
{
"type": "string",
"columns": [
"string"
]
}
]
},
"ydsTarget": {
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"saveTxOrder": "boolean",
"compressionCodec": "string",
"serializer": {
// Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
"serializerAuto": "object",
"serializerJson": "object",
"serializerDebezium": {
"serializerParameters": [
{
"key": "string",
"value": "string"
}
]
}
// end of the list of possible fields
},
"endpoint": "string",
"subnetId": "string",
"securityGroups": [
"string"
]
}
// end of the list of possible fields
}
},
"runtime": {
// Includes only one of the fields `ycRuntime`
"ycRuntime": {
"jobCount": "string",
"uploadShardParams": {
"jobCount": "string",
"processCount": "string"
}
}
// end of the list of possible fields
},
"status": "string",
"type": "string",
"warning": "string",
"transformation": {
"transformers": [
{
// Includes only one of the fields `maskField`, `filterColumns`, `renameTables`, `replacePrimaryKey`, `convertToString`, `sharderTransformer`, `tableSplitterTransformer`, `filterRows`
"maskField": {
"tables": {
"includeTables": [
"string"
],
"excludeTables": [
"string"
]
},
"columns": [
"string"
],
"function": {
// Includes only one of the fields `maskFunctionHash`
"maskFunctionHash": {
"userDefinedSalt": "string"
}
// end of the list of possible fields
}
},
"filterColumns": {
"tables": {
"includeTables": [
"string"
],
"excludeTables": [
"string"
]
},
"columns": {
"includeColumns": [
"string"
],
"excludeColumns": [
"string"
]
}
},
"renameTables": {
"renameTables": [
{
"originalName": {
"nameSpace": "string",
"name": "string"
},
"newName": {
"nameSpace": "string",
"name": "string"
}
}
]
},
"replacePrimaryKey": {
"tables": {
"includeTables": [
"string"
],
"excludeTables": [
"string"
]
},
"keys": [
"string"
]
},
"convertToString": {
"tables": {
"includeTables": [
"string"
],
"excludeTables": [
"string"
]
},
"columns": {
"includeColumns": [
"string"
],
"excludeColumns": [
"string"
]
}
},
"sharderTransformer": {
"tables": {
"includeTables": [
"string"
],
"excludeTables": [
"string"
]
},
// Includes only one of the fields `columns`, `random`
"columns": {
"includeColumns": [
"string"
],
"excludeColumns": [
"string"
]
},
"random": "object",
// end of the list of possible fields
"shardsCount": "string"
},
"tableSplitterTransformer": {
"tables": {
"includeTables": [
"string"
],
"excludeTables": [
"string"
]
},
"columns": [
"string"
],
"splitter": "string"
},
"filterRows": {
"tables": {
"includeTables": [
"string"
],
"excludeTables": [
"string"
]
},
"filter": "string",
"filters": [
"string"
]
}
// end of the list of possible fields
}
]
},
"dataObjects": {
"includeObjects": [
"string"
]
},
"prestable": "boolean",
"replicationRuntime": {
// Includes only one of the fields `ycRuntime`
"ycRuntime": {
"jobCount": "string",
"uploadShardParams": {
"jobCount": "string",
"processCount": "string"
}
}
// end of the list of possible fields
}
}
Transfer core entity
|
Field |
Description |
|
id |
string |
|
folderId |
string |
|
name |
string |
|
description |
string |
|
labels |
object (map<string, string>) |
|
source |
|
|
target |
|
|
runtime |
Runtime parameters for the transfer |
|
status |
enum (TransferStatus)
|
|
type |
enum (TransferType) Type of the transfer. One of SNAPSHOT_ONLY, INCREMENT_ONLY,
|
|
warning |
string Error description if transfer has any errors. |
|
transformation |
Transformation for the transfer. |
|
dataObjects |
|
|
prestable |
boolean |
|
replicationRuntime |
Replication runtime parameters for the transfer |
Endpoint
Data Transfer endpoint. For more information, see the official
documentation
|
Field |
Description |
|
id |
string |
|
folderId |
string |
|
name |
string |
|
description |
string |
|
labels |
object (map<string, string>) |
|
settings |
DataTransfer Endpoint Settings block |
EndpointSettings
|
Field |
Description |
|
mysqlSource |
Includes only one of the fields |
|
postgresSource |
Includes only one of the fields |
|
ydbSource |
Includes only one of the fields |
|
ydsSource |
Includes only one of the fields |
|
kafkaSource |
Includes only one of the fields |
|
mongoSource |
Includes only one of the fields |
|
clickhouseSource |
Includes only one of the fields |
|
mysqlTarget |
Includes only one of the fields |
|
postgresTarget |
Includes only one of the fields |
|
clickhouseTarget |
Includes only one of the fields |
|
ydbTarget |
Includes only one of the fields |
|
kafkaTarget |
Includes only one of the fields |
|
mongoTarget |
Includes only one of the fields |
|
metrikaSource |
Includes only one of the fields |
|
ydsTarget |
Includes only one of the fields |
MysqlSource
Settings specific to the MySQL source endpoint
|
Field |
Description |
|
connection |
Database connection settings |
|
database |
string Name of the database to transfer You can leave it empty, then it will be possible to transfer tables from several |
|
user |
string User for database access. Required unless connection manager connection is used |
|
password |
Password for database access. |
|
timezone |
string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from |
|
objectTransferSettings |
Schema migration |
|
includeTablesRegex[] |
string List of regular expressions of table names which should be transferred. A table |
|
excludeTablesRegex[] |
string Opposite of |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
serviceDatabase |
string Database for service tables |
MysqlConnection
|
Field |
Description |
|
mdbClusterId |
string Managed Service for MySQL cluster ID Includes only one of the fields |
|
onPremise |
Connection options for on-premise MySQL Includes only one of the fields |
|
connectionManagerConnection |
Get Mysql installation params and credentials from Connection Manager Includes only one of the fields |
OnPremiseMysql
|
Field |
Description |
|
port |
string (int64) Port for the database connection |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
hosts[] |
string List of host names of the MySQL server. Exactly one host is expected |
|
tlsMode |
TLS settings for server connection. Disabled by default. |
TLSMode
TLS configuration
|
Field |
Description |
|
enabled |
TLS is used for the server connection Includes only one of the fields |
TLSConfig
|
Field |
Description |
|
caCertificate |
string CA certificate X.509 certificate of the certificate authority which issued the server's |
ConnectionManagerConnection
Use Connection Manager connection
|
Field |
Description |
|
connectionId |
string ID of connection in Connection Manager with installation params and credetials |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
Secret
|
Field |
Description |
|
raw |
string Raw secret value Includes only one of the fields |
MysqlObjectTransferSettings
|
Field |
Description |
|
view |
enum (ObjectTransferStage) Views CREATE VIEW ...
|
|
routine |
enum (ObjectTransferStage) Routines CREATE PROCEDURE ... ; CREATE FUNCTION ... ;
|
|
trigger |
enum (ObjectTransferStage) Triggers CREATE TRIGGER ...
|
|
tables |
enum (ObjectTransferStage)
|
PostgresSource
Settings specific to the PostgreSQL source endpoint.
|
Field |
Description |
|
connection |
Database connection settings |
|
database |
string Name of the database to transfer |
|
user |
string User for database access. Required unless Connection Manager connection is used. |
|
password |
Password for database access. |
|
includeTables[] |
string List of tables to transfer, formatted as |
|
excludeTables[] |
string List of tables which will not be transfered, formatted as |
|
slotByteLagLimit |
string (int64) Maximum WAL size held by the replication slot (API - in bytes, terraform - in |
|
serviceSchema |
string Name of the database schema in which auxiliary tables needed for the transfer |
|
objectTransferSettings |
PostgresObjectTransferSettings Defines which database schema objects should be transferred, e.g. views, |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
PostgresConnection
|
Field |
Description |
|
mdbClusterId |
string Managed Service for PostgreSQL cluster ID Includes only one of the fields |
|
onPremise |
Connection options for on-premise PostgreSQL Includes only one of the fields |
|
connectionManagerConnection |
Get Postgres installation params and credentials from Connection Manager Includes only one of the fields |
OnPremisePostgres
|
Field |
Description |
|
port |
string (int64) PG port. Will be used if the cluster ID is not specified. |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
hosts[] |
string PG installation hosts |
|
tlsMode |
TLS settings for server connection. Disabled by default. |
PostgresObjectTransferSettings
|
Field |
Description |
|
sequence |
enum (ObjectTransferStage) Sequences CREATE SEQUENCE ...
|
|
sequenceOwnedBy |
enum (ObjectTransferStage) Owned sequences CREATE SEQUENCE ... OWNED BY ...
|
|
table |
enum (ObjectTransferStage) Tables CREATE TABLE ...
|
|
primaryKey |
enum (ObjectTransferStage) Primary keys ALTER TABLE ... ADD PRIMARY KEY ...
|
|
fkConstraint |
enum (ObjectTransferStage) Foreign keys ALTER TABLE ... ADD FOREIGN KEY ...
|
|
defaultValues |
enum (ObjectTransferStage) Default values ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ...
|
|
constraint |
enum (ObjectTransferStage) Constraints ALTER TABLE ... ADD CONSTRAINT ...
|
|
index |
enum (ObjectTransferStage) Indexes CREATE INDEX ...
|
|
view |
enum (ObjectTransferStage) Views CREATE VIEW ...
|
|
function |
enum (ObjectTransferStage) Functions CREATE FUNCTION ...
|
|
trigger |
enum (ObjectTransferStage) Triggers CREATE TRIGGER ...
|
|
type |
enum (ObjectTransferStage) Types CREATE TYPE ...
|
|
rule |
enum (ObjectTransferStage) Rules CREATE RULE ...
|
|
collation |
enum (ObjectTransferStage) Collations CREATE COLLATION ...
|
|
policy |
enum (ObjectTransferStage) Policies CREATE POLICY ...
|
|
cast |
enum (ObjectTransferStage) Casts CREATE CAST ...
|
|
materializedView |
enum (ObjectTransferStage) Materialized views CREATE MATERIALIZED VIEW ...
|
|
sequenceSet |
enum (ObjectTransferStage)
|
YdbSource
Settings specific to the YDB source endpoint
|
Field |
Description |
|
database |
string Database path in YDB where tables are stored. |
|
instance |
string Instance of YDB. example: ydb-ru-prestable.yandex.net:2135. |
|
paths[] |
string A list of paths which should be uploaded. When not specified, all available |
|
serviceAccountId |
string Service account ID for interaction with database |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
saKeyContent |
string Authorization Key |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
changefeedCustomName |
string Pre-created change feed if any |
|
changefeedCustomConsumerName |
string Consumer for pre-created change feed if any |
YDSSource
Settings specific to the YDS source endpoint
|
Field |
Description |
|
database |
string Database path in YDB for streams |
|
stream |
string Stream to read |
|
serviceAccountId |
string Service account ID which has read access to the stream. |
|
supportedCodecs[] |
enum (YdsCompressionCodec) List of supported compression codecs
|
|
parser |
Data parsing rules |
|
allowTtlRewind |
boolean Should continue working, if consumer read lag exceed TTL of topic |
|
endpoint |
string YDS Endpoint for dedicated db |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
consumer |
string Custom consumer - for important streams |
Parser
|
Field |
Description |
|
jsonParser |
Parse data in json format Includes only one of the fields |
|
auditTrailsV1Parser |
object Parse Audit Trails data. Empty struct Includes only one of the fields |
|
cloudLoggingParser |
object Parse Cloud Logging data. Empty struct Includes only one of the fields |
|
tskvParser |
Parse data in tskv format Includes only one of the fields |
GenericParserCommon
|
Field |
Description |
|
dataSchema |
Data parsing scheme |
|
nullKeysAllowed |
boolean Allow null keys, if no - null keys will be putted to unparsed data |
|
addRestColumn |
boolean Will add _rest column for all unknown fields |
|
unescapeStringValues |
boolean Unescape string values |
DataSchema
|
Field |
Description |
|
jsonFields |
string Description of the data schema as JSON specification Includes only one of the fields |
|
fields |
Description of the data schema in the array of Includes only one of the fields |
FieldList
|
Field |
Description |
|
fields[] |
Description of the column schema in the array of |
ColSchema
|
Field |
Description |
|
name |
string Field name |
|
type |
enum (ColumnType) Field type, one of:
|
|
key |
boolean Mark field as Primary Key |
|
required |
boolean Mark field as required |
|
path |
string Path to the field |
KafkaSource
Settings specific to the Kafka source endpoint
|
Field |
Description |
|
connection |
Connection settings |
|
auth |
Authentication settings |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
topicName |
string Deprecated*. Please use |
|
transformer |
Transform data with a custom Cloud Function |
|
parser |
Data parsing parameters. If not set, the source messages are read in raw |
|
topicNames[] |
string List of full source topic names to read |
KafkaConnectionOptions
|
Field |
Description |
|
clusterId |
string Managed Service for Kafka cluster ID. Includes only one of the fields |
|
onPremise |
Connection options for on-premise Kafka Includes only one of the fields |
|
connectionManagerConnection |
Get Kafka installation params and credentials from Connection Manager Includes only one of the fields |
OnPremiseKafka
On-premise Kafka installation options
|
Field |
Description |
|
brokerUrls[] |
string Kafka broker URLs |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
tlsMode |
TLS settings for broker connection. Disabled by default. |
KafkaAuth
|
Field |
Description |
|
sasl |
Authentication with SASL Includes only one of the fields |
|
noAuth |
object No authentication Includes only one of the fields |
KafkaSaslSecurity
|
Field |
Description |
|
user |
string User name |
|
mechanism |
enum (KafkaMechanism) SASL mechanism for authentication, use one of: KAFKA_MECHANISM_SHA256,
|
|
password |
Password for user |
DataTransformationOptions
|
Field |
Description |
|
cloudFunction |
string Cloud function |
|
numberOfRetries |
string (int64) Number of retries |
|
bufferSize |
string Buffer size for function. Maximum 4 GB. Use value with units, i.e. 10 B, 20 kB, |
|
bufferFlushInterval |
string Flush interval |
|
invocationTimeout |
string Invocation timeout |
|
serviceAccountId |
string Service account |
MongoSource
Settings specific to the MongoDB source endpoint
|
Field |
Description |
|
connection |
Connection settings |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
collections[] |
List of collections for replication. Empty list implies replication of all |
|
excludedCollections[] |
List of forbidden collections for replication. Allowed to use * as collection |
|
secondaryPreferredMode |
boolean Read mode for mongo client: whether the secondary server should be preferred to |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
MongoConnection
|
Field |
Description |
|
connectionOptions |
Includes only one of the fields |
MongoConnectionOptions
|
Field |
Description |
|
mdbClusterId |
string Identifier of the Yandex StoreDoc cluster Includes only one of the fields |
|
onPremise |
Connection settings of the on-premise MongoDB server Includes only one of the fields |
|
connectionManagerConnection |
MongoConnectionManagerConnection Get StoreDoc/MongoDB installation params and credentials from Connection Manager Includes only one of the fields |
|
user |
string User name, required unless connection_manager_connection is used |
|
password |
Password for user |
|
authSource |
string Database name associated with the credentials |
OnPremiseMongo
|
Field |
Description |
|
hosts[] |
string Host names of the replica set |
|
port |
string (int64) TCP Port number |
|
replicaSet |
string Replica set name |
|
tlsMode |
TLS settings for the server connection. Empty implies plaintext connection |
MongoConnectionManagerConnection
|
Field |
Description |
|
connectionId |
string ID of connectionmanager connection with mongodb/Yandex Storedoc installation |
|
replicaSet |
string Replica set name, used only for on-premise mongodb installations |
MongoCollection
|
Field |
Description |
|
databaseName |
string |
|
collectionName |
string |
ClickhouseSource
Settings specific to the ClickHouse source endpoint
|
Field |
Description |
|
connection |
Connection settings |
|
includeTables[] |
string White list of tables for replication. If none or empty list is presented - will |
|
excludeTables[] |
string Exclude list of tables for replication. If none or empty list is presented - |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
clickhouseClusterName |
string Name of the ClickHouse cluster. For Managed ClickHouse that is name of |
ClickhouseConnection
|
Field |
Description |
|
connectionOptions |
Includes only one of the fields |
ClickhouseConnectionOptions
|
Field |
Description |
|
onPremise |
Connection settings of the on-premise ClickHouse server Includes only one of the fields |
|
connectionManagerConnection |
Get ClickHouse installation params and credentials from Connection Manager Includes only one of the fields |
|
mdbClusterId |
string Identifier of the Managed ClickHouse cluster Includes only one of the fields |
|
user |
string User for database access. Required unless connection_manager_connection is used |
|
password |
Password for the database access |
|
database |
string Database name |
OnPremiseClickhouse
|
Field |
Description |
|
shards[] |
|
|
httpPort |
string (int64) |
|
nativePort |
string (int64) |
|
tlsMode |
TLS settings for server connection. Disabled by default |
ClickhouseShard
|
Field |
Description |
|
name |
string |
|
hosts[] |
string |
MysqlTarget
Settings specific to the MySQL target endpoint
|
Field |
Description |
|
connection |
Database connection settings |
|
database |
string Database name Allowed to leave it empty, then the tables will be created in databases with the |
|
user |
string User for database access. Required unless connection manager connection is used |
|
password |
Password for database access. |
|
sqlMode |
string sql_mode to use when |
|
skipConstraintChecks |
boolean Disable constraints checks |
|
timezone |
string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from |
|
cleanupPolicy |
enum (CleanupPolicy) Cleanup policy for activate, reactivate and reupload processes.
|
|
serviceDatabase |
string Database schema for service table |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
isSchemaMigrationDisabled |
boolean Whether can change table schema if schema changed on source |
PostgresTarget
Settings specific to the PostgreSQL target endpoint
|
Field |
Description |
|
connection |
Database connection settings |
|
database |
string Target database name |
|
user |
string User for database access. Required unless Connection Manager connection is used |
|
password |
Password for database access. |
|
cleanupPolicy |
enum (CleanupPolicy) Cleanup policy for activate, reactivate and reupload processes.
|
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
isSchemaMigrationDisabled |
boolean Whether can change table schema if schema changed on source |
ClickhouseTarget
Settings specific to the ClickHouse target endpoint
|
Field |
Description |
|
connection |
Connection settings |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
altNames[] |
Table renaming rules in target |
|
cleanupPolicy |
enum (ClickhouseCleanupPolicy) How to clean collections when activating the transfer. One of
|
|
sharding |
Shard selection rules for the data being transferred |
|
isSchemaMigrationDisabled |
boolean Whether can change table schema if schema changed on source |
|
clickhouseClusterName |
string Name of the ClickHouse cluster. For Managed ClickHouse that is name of |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
AltName
|
Field |
Description |
|
fromName |
string Source table name |
|
toName |
string Target table name |
ClickhouseSharding
|
Field |
Description |
|
columnValueHash |
Shard data by the hash value of the specified column Includes only one of the fields |
|
customMapping |
A custom shard mapping by the value of the specified column Includes only one of the fields |
ColumnValueHash
|
Field |
Description |
|
columnName |
string The name of the column to calculate hash from |
ColumnValueMapping
|
Field |
Description |
|
columnName |
string The name of the column to inspect when deciding the shard to chose for an |
|
mapping[] |
The mapping of the specified column values to the shard names |
ValueToShard
|
Field |
Description |
|
columnValue |
The value of the column. Currently only the string columns are supported |
|
shardName |
string The name of the shard into which all the rows with the specified |
ColumnValue
|
Field |
Description |
|
stringValue |
string Includes only one of the fields |
YdbTarget
Settings specific to the YDB target endpoint
|
Field |
Description |
|
database |
string Database path in YDB where tables are stored. |
|
instance |
string Instance of YDB. example: ydb-ru-prestable.yandex.net:2135. |
|
path |
string Path extension for database, each table will be layouted into this path |
|
serviceAccountId |
string Service account ID for interaction with database |
|
cleanupPolicy |
enum (YdbCleanupPolicy) Cleanup policy determine how to clean collections when activating the transfer.
|
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
saKeyContent |
string Authentication key |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
isTableColumnOriented |
boolean Whether a column-oriented (i.e. OLAP) tables should be created. |
|
defaultCompression |
enum (YdbDefaultCompression) Compression that will be used for default columns family on YDB table creation.
|
|
isSchemaMigrationDisabled |
boolean Whether can change table schema if schema changed on source |
KafkaTarget
Settings specific to the Kafka target endpoint
|
Field |
Description |
|
connection |
Connection settings |
|
auth |
Authentication settings |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
|
topicSettings |
Target topic settings |
|
serializer |
Data serialization format settings |
KafkaTargetTopicSettings
|
Field |
Description |
|
topic |
All messages will be sent to one topic Includes only one of the fields |
|
topicPrefix |
string Topic prefix Includes only one of the fields |
KafkaTargetTopic
|
Field |
Description |
|
topicName |
string Full topic name |
|
saveTxOrder |
boolean Save transactions order |
Serializer
Data serialization format
|
Field |
Description |
|
serializerAuto |
object Empty block. Select the serialization format automatically Includes only one of the fields |
|
serializerJson |
object Empty block. Serialize data in json format Includes only one of the fields |
|
serializerDebezium |
Serialize data in debezium json format Includes only one of the fields |
SerializerDebezium
Serialize data in json format
|
Field |
Description |
|
serializerParameters[] |
A list of Debezium parameters set by the structure of the |
DebeziumSerializerParameter
|
Field |
Description |
|
key |
string Name of the serializer parameter |
|
value |
string Value of the serializer parameter |
MongoTarget
Settings specific to the MongoDB target endpoint
|
Field |
Description |
|
connection |
Connection settings |
|
database |
string Database name. If not empty, then all the data will be written to the database |
|
cleanupPolicy |
enum (CleanupPolicy) How to clean collections when activating the transfer. One of
|
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
MetrikaSource
Settings specific to the Yandex Metrika source endpoint
|
Field |
Description |
|
counterIds[] |
string (int64) Counter IDs |
|
token |
Authentication token |
|
streams[] |
Streams |
MetrikaStream
|
Field |
Description |
|
type |
enum (MetrikaStreamType) Stream type, one of: METRIKA_STREAM_TYPE_HITS, METRIKA_STREAM_TYPE_VISITS,
|
|
columns[] |
string Column names |
YDSTarget
Settings specific to the YDS target endpoint
|
Field |
Description |
|
database |
string Database path in YDB for streams |
|
stream |
string Stream to write to |
|
serviceAccountId |
string Service account ID which has read access to the stream |
|
saveTxOrder |
boolean Save transaction order |
|
compressionCodec |
enum (YdsCompressionCodec) Codec to use for output data compression. If not specified, no compression will
|
|
serializer |
Data serialization format |
|
endpoint |
string YDS Endpoint for dedicated db |
|
subnetId |
string Identifier of the Yandex Cloud VPC subnetwork to user for accessing the |
|
securityGroups[] |
string List of security groups that the transfer associated with this endpoint should |
Runtime
|
Field |
Description |
|
ycRuntime |
Includes only one of the fields |
YcRuntime
YC Runtime parameters for the transfer
|
Field |
Description |
|
jobCount |
string (int64) Number of workers in parallel replication. |
|
uploadShardParams |
Parallel snapshot parameters |
ShardingUploadParams
Parallel snapshot parameters
|
Field |
Description |
|
jobCount |
string (int64) Number of workers. |
|
processCount |
string (int64) Number of threads. |
Transformation
Transformation is converting data using special transformer functions.
These functions are executed on a data stream, applied to each data change item,
and transform them.
A transformer can be run at both the metadata and data levels.
Data can only be transformed if the source and target are of different types.
|
Field |
Description |
|
transformers[] |
A list of transformers. You can specify exactly 1 transformer in each element of |
Transformer
Some transformers may have limitations and only apply to some source-target
pairs.
|
Field |
Description |
|
maskField |
Mask field transformer allows you to hash data Includes only one of the fields |
|
filterColumns |
Set up a list of table columns to transfer Includes only one of the fields |
|
renameTables |
Set rules for renaming tables by specifying the current names of the tables in Includes only one of the fields |
|
replacePrimaryKey |
Override primary keys. Includes only one of the fields |
|
convertToString |
Convert column values to strings Includes only one of the fields |
|
sharderTransformer |
Set the number of shards for particular tables and a list of columns whose Includes only one of the fields |
|
tableSplitterTransformer |
Splits the X table into multiple tables (X_1, X_2, ..., X_n) based on data. Includes only one of the fields |
|
filterRows |
This filter only applies to transfers with queues (Logbroker or Apache Kafka®) Includes only one of the fields |
MaskFieldTransformer
Mask field transformer allows you to hash data
|
Field |
Description |
|
tables |
List of included and excluded tables |
|
columns[] |
string Specify the name of the column for data masking (a regular expression). |
|
function |
Mask function |
TablesFilter
Filter tables using lists of included and excluded tables.
|
Field |
Description |
|
includeTables[] |
string List of tables that will be included to transfer |
|
excludeTables[] |
string List of tables that will be excluded to transfer |
MaskFunction
Mask function
|
Field |
Description |
|
maskFunctionHash |
Hash mask function Includes only one of the fields |
MaskFunctionHash
Hash data using HMAC
|
Field |
Description |
|
userDefinedSalt |
string This string will be used in the HMAC(sha256, salt) function applied to the |
FilterColumnsTransformer
Set up a list of table columns to transfer
|
Field |
Description |
|
tables |
List of the tables to filter using lists of included and excluded tables. |
|
columns |
List of the columns to transfer to the target tables using lists of included and |
ColumnsFilter
Filter columns using lists of included and excluded columns.
|
Field |
Description |
|
includeColumns[] |
string List of columns that will be included to transfer |
|
excludeColumns[] |
string List of columns that will be excluded to transfer |
RenameTablesTransformer
Set rules for renaming tables by specifying the current names of the tables in
the source and new names for these tables in the target.
|
Field |
Description |
|
renameTables[] |
List of renaming rules |
RenameTable
Specify rule for renaming table
|
Field |
Description |
|
originalName |
Specify the current names of the table in the source |
|
newName |
Specify the new names for this table in the target |
Table
|
Field |
Description |
|
nameSpace |
string |
|
name |
string |
ReplacePrimaryKeyTransformer
Override primary keys
|
Field |
Description |
|
tables |
List of included and excluded tables |
|
keys[] |
string List of columns to be used as primary keys |
ToStringTransformer
Convert column values to strings
The values will be converted depending on the source type
Conversion rules are described here:
https://cloud.yandex.com/en/docs/data-transfer/concepts/data-transformation#convert-to-string
|
Field |
Description |
|
tables |
List of included and excluded tables |
|
columns |
List of included and excluded columns |
SharderTransformer
Set the number of shards for particular tables and a list of columns whose
values will be used for calculating a hash to determine a shard.
|
Field |
Description |
|
tables |
List of included and excluded tables |
|
columns |
List of included and excluded columns Includes only one of the fields |
|
random |
object Includes only one of the fields |
|
shardsCount |
string (int64) Number of shards |
TableSplitterTransformer
A transfer splits the X table into multiple tables (X_1, X_2, ..., X_n) based on
data.
If a row was located in the X table before it was split, it is now in the X_i
table,
where i is determined by the column list and split string parameters.
Example:
If the column list has two columns, month of birth and gender, specified and the
split string states @,
information about an employee whose name is John and who was born on February
11, 1984,
from the Employees table will get to a new table named Employees@February@male.
|
Field |
Description |
|
tables |
List of included and excluded tables |
|
columns[] |
string Specify the columns in the tables to be partitioned. |
|
splitter |
string Specify the split string to be used for merging components in a new table name. |
FilterRowsTransformer
This filter only applies to transfers with queues (Logbroker or Apache Kafka®)
as a data source.
When running a transfer, only the strings meeting the specified criteria remain
in a changefeed.
|
Field |
Description |
|
tables |
List of included and excluded tables. |
|
filter |
string Filtering criterion. This can be comparison operators for numeric, string, and |
|
filters[] |
string Data is transported if it satisfies at least one of filters. Consider that there |
DataObjects
|
Field |
Description |
|
includeObjects[] |
string |