Data Transfer API, gRPC: EndpointService.Create
- gRPC request
- CreateEndpointRequest
- EndpointSettings
- MysqlSource
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- Secret
- MysqlObjectTransferSettings
- PostgresSource
- PostgresConnection
- OnPremisePostgres
- PostgresObjectTransferSettings
- YdbSource
- YDSSource
- Parser
- GenericParserCommon
- DataSchema
- FieldList
- ColSchema
- AuditTrailsV1Parser
- CloudLoggingParser
- KafkaSource
- KafkaConnectionOptions
- OnPremiseKafka
- KafkaAuth
- KafkaSaslSecurity
- NoAuth
- DataTransformationOptions
- MongoSource
- MongoConnection
- MongoConnectionOptions
- OnPremiseMongo
- MongoCollection
- ClickhouseSource
- ClickhouseConnection
- ClickhouseConnectionOptions
- OnPremiseClickhouse
- ClickhouseShard
- MysqlTarget
- PostgresTarget
- ClickhouseTarget
- AltName
- ClickhouseSharding
- ColumnValueHash
- ColumnValueMapping
- ValueToShard
- ColumnValue
- YdbTarget
- KafkaTarget
- KafkaTargetTopicSettings
- KafkaTargetTopic
- Serializer
- SerializerAuto
- SerializerJSON
- SerializerDebezium
- DebeziumSerializerParameter
- MongoTarget
- MetrikaSource
- MetrikaStream
- YDSTarget
- operation.Operation
gRPC request
rpc Create (CreateEndpointRequest) returns (operation.Operation)
CreateEndpointRequest
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "string",
"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`
"mdbClusterId": "string",
"onPremise": {
"port": "int64",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
}
// 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": "ObjectTransferStage",
"routine": "ObjectTransferStage",
"trigger": "ObjectTransferStage",
"tables": "ObjectTransferStage"
},
"includeTablesRegex": [
"string"
],
"excludeTablesRegex": [
"string"
],
"securityGroups": [
"string"
],
"serviceDatabase": "string"
},
"postgresSource": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`
"mdbClusterId": "string",
"onPremise": {
"port": "int64",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
}
// 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": "int64",
"serviceSchema": "string",
"objectTransferSettings": {
"sequence": "ObjectTransferStage",
"sequenceOwnedBy": "ObjectTransferStage",
"table": "ObjectTransferStage",
"primaryKey": "ObjectTransferStage",
"fkConstraint": "ObjectTransferStage",
"defaultValues": "ObjectTransferStage",
"constraint": "ObjectTransferStage",
"index": "ObjectTransferStage",
"view": "ObjectTransferStage",
"function": "ObjectTransferStage",
"trigger": "ObjectTransferStage",
"type": "ObjectTransferStage",
"rule": "ObjectTransferStage",
"collation": "ObjectTransferStage",
"policy": "ObjectTransferStage",
"cast": "ObjectTransferStage",
"materializedView": "ObjectTransferStage",
"sequenceSet": "ObjectTransferStage"
},
"securityGroups": [
"string"
]
},
"ydbSource": {
"database": "string",
"instance": "string",
"paths": [
"string"
],
"serviceAccountId": "string",
"subnetId": "string",
"saKeyContent": "string",
"securityGroups": [
"string"
],
"changefeedCustomName": "string"
},
"ydsSource": {
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"supportedCodecs": [
"YdsCompressionCodec"
],
"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": "ColumnType",
"key": "bool",
"required": "bool",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "bool",
"addRestColumn": "bool",
"unescapeStringValues": "bool"
},
"auditTrailsV1Parser": "AuditTrailsV1Parser",
"cloudLoggingParser": "CloudLoggingParser",
"tskvParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "ColumnType",
"key": "bool",
"required": "bool",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "bool",
"addRestColumn": "bool",
"unescapeStringValues": "bool"
}
// end of the list of possible fields
},
"allowTtlRewind": "bool",
"endpoint": "string",
"subnetId": "string",
"securityGroups": [
"string"
],
"consumer": "string"
},
"kafkaSource": {
"connection": {
// Includes only one of the fields `clusterId`, `onPremise`
"clusterId": "string",
"onPremise": {
"brokerUrls": [
"string"
],
"subnetId": "string",
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
}
// end of the list of possible fields
},
"auth": {
// Includes only one of the fields `sasl`, `noAuth`
"sasl": {
"user": "string",
"mechanism": "KafkaMechanism",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
}
},
"noAuth": "NoAuth"
// end of the list of possible fields
},
"securityGroups": [
"string"
],
"topicName": "string",
"transformer": {
"cloudFunction": "string",
"numberOfRetries": "int64",
"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": "ColumnType",
"key": "bool",
"required": "bool",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "bool",
"addRestColumn": "bool",
"unescapeStringValues": "bool"
},
"auditTrailsV1Parser": "AuditTrailsV1Parser",
"cloudLoggingParser": "CloudLoggingParser",
"tskvParser": {
"dataSchema": {
// Includes only one of the fields `jsonFields`, `fields`
"jsonFields": "string",
"fields": {
"fields": [
{
"name": "string",
"type": "ColumnType",
"key": "bool",
"required": "bool",
"path": "string"
}
]
}
// end of the list of possible fields
},
"nullKeysAllowed": "bool",
"addRestColumn": "bool",
"unescapeStringValues": "bool"
}
// 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`
"mdbClusterId": "string",
"onPremise": {
"hosts": [
"string"
],
"port": "int64",
"replicaSet": "string",
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
// 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": "bool",
"securityGroups": [
"string"
]
},
"clickhouseSource": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `onPremise`, `mdbClusterId`
"onPremise": {
"shards": [
{
"name": "string",
"hosts": [
"string"
]
}
],
"httpPort": "int64",
"nativePort": "int64",
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"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`
"mdbClusterId": "string",
"onPremise": {
"port": "int64",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
}
// 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": "bool",
"timezone": "string",
"cleanupPolicy": "CleanupPolicy",
"serviceDatabase": "string",
"securityGroups": [
"string"
]
},
"postgresTarget": {
"connection": {
// Includes only one of the fields `mdbClusterId`, `onPremise`
"mdbClusterId": "string",
"onPremise": {
"port": "int64",
"subnetId": "string",
"hosts": [
"string"
],
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
}
// 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": "CleanupPolicy",
"securityGroups": [
"string"
]
},
"clickhouseTarget": {
"connection": {
// Includes only one of the fields `connectionOptions`
"connectionOptions": {
// Includes only one of the fields `onPremise`, `mdbClusterId`
"onPremise": {
"shards": [
{
"name": "string",
"hosts": [
"string"
]
}
],
"httpPort": "int64",
"nativePort": "int64",
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
"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": "ClickhouseCleanupPolicy",
"sharding": {
// Includes only one of the fields `columnValueHash`, `customMapping`, `transferId`, `roundRobin`
"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"
}
]
},
"transferId": "google.protobuf.Empty",
"roundRobin": "google.protobuf.Empty"
// end of the list of possible fields
},
"clickhouseClusterName": "string",
"securityGroups": [
"string"
]
},
"ydbTarget": {
"database": "string",
"instance": "string",
"path": "string",
"serviceAccountId": "string",
"cleanupPolicy": "YdbCleanupPolicy",
"subnetId": "string",
"saKeyContent": "string",
"securityGroups": [
"string"
],
"isTableColumnOriented": "bool",
"defaultCompression": "YdbDefaultCompression"
},
"kafkaTarget": {
"connection": {
// Includes only one of the fields `clusterId`, `onPremise`
"clusterId": "string",
"onPremise": {
"brokerUrls": [
"string"
],
"subnetId": "string",
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
}
// end of the list of possible fields
},
"auth": {
// Includes only one of the fields `sasl`, `noAuth`
"sasl": {
"user": "string",
"mechanism": "KafkaMechanism",
"password": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
}
},
"noAuth": "NoAuth"
// end of the list of possible fields
},
"securityGroups": [
"string"
],
"topicSettings": {
// Includes only one of the fields `topic`, `topicPrefix`
"topic": {
"topicName": "string",
"saveTxOrder": "bool"
},
"topicPrefix": "string"
// end of the list of possible fields
},
"serializer": {
// Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
"serializerAuto": "SerializerAuto",
"serializerJson": "SerializerJSON",
"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`
"mdbClusterId": "string",
"onPremise": {
"hosts": [
"string"
],
"port": "int64",
"replicaSet": "string",
"tlsMode": {
// Includes only one of the fields `disabled`, `enabled`
"disabled": "google.protobuf.Empty",
"enabled": {
"caCertificate": "string"
}
// end of the list of possible fields
}
},
// 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": "CleanupPolicy",
"subnetId": "string",
"securityGroups": [
"string"
]
},
"metrikaSource": {
"counterIds": [
"int64"
],
"token": {
// Includes only one of the fields `raw`
"raw": "string"
// end of the list of possible fields
},
"streams": [
{
"type": "MetrikaStreamType",
"columns": [
"string"
]
}
]
},
"ydsTarget": {
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"saveTxOrder": "bool",
"serializer": {
// Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
"serializerAuto": "SerializerAuto",
"serializerJson": "SerializerJSON",
"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
}
}
Field |
Description |
folderId |
string |
name |
string |
description |
string |
labels |
string |
settings |
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
Field |
Description |
connection |
Database connection settings |
database |
string Database name You can leave it empty, then it will be possible to transfer tables from several |
user |
string User for database access. |
password |
Password for database access. |
timezone |
string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from |
objectTransferSettings |
Schema migration Select database objects to be transferred during activation or deactivation. |
includeTablesRegex[] |
string |
excludeTablesRegex[] |
string |
securityGroups[] |
string Security groups |
serviceDatabase |
string Database for service tables Default: data source database. Here created technical tables (__tm_keeper, |
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 |
OnPremiseMysql
Field |
Description |
port |
int64 Database port |
subnetId |
string Network interface for endpoint. If none will assume public ipv4 |
hosts[] |
string |
tlsMode |
TLS settings for server connection. Disabled by default. |
TLSMode
Field |
Description |
disabled |
Includes only one of the fields |
enabled |
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 |
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
Field |
Description |
connection |
Database connection settings |
database |
string Database name |
user |
string User for database access. not required as may be in connection |
password |
Password for database access. |
includeTables[] |
string Included tables If none or empty list is presented, all tables are replicated. Full table name |
excludeTables[] |
string Excluded tables If none or empty list is presented, all tables are replicated. Full table name |
slotByteLagLimit |
int64 Maximum lag of replication slot (in bytes); after exceeding this limit |
serviceSchema |
string Database schema for service tables (__consumer_keeper, |
objectTransferSettings |
PostgresObjectTransferSettings Select database objects to be transferred during activation or deactivation. |
securityGroups[] |
string Security groups |
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 |
OnPremisePostgres
Field |
Description |
port |
int64 Will be used if the cluster ID is not specified. |
subnetId |
string Network interface for endpoint. If none will assume public ipv4 |
hosts[] |
string |
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
Field |
Description |
database |
string Path in YDB where to store tables |
instance |
string Instance of YDB. example: ydb-ru-prestable.yandex.net:2135 |
paths[] |
string |
serviceAccountId |
string |
subnetId |
string Network interface for endpoint. If none will assume public ipv4 |
saKeyContent |
string Authorization Key |
securityGroups[] |
string Security groups |
changefeedCustomName |
string Pre-created change feed |
YDSSource
Field |
Description |
database |
string Database |
stream |
string Stream |
serviceAccountId |
string SA which has read access to the stream. |
supportedCodecs[] |
enum YdsCompressionCodec Compression codec
|
parser |
Data parsing rules |
allowTtlRewind |
bool Should continue working, if consumer read lag exceed TTL of topic |
endpoint |
string for dedicated db |
subnetId |
string Network interface for endpoint. If none will assume public ipv4 |
securityGroups[] |
string Security groups |
consumer |
string for important streams |
Parser
Field |
Description |
jsonParser |
Includes only one of the fields |
auditTrailsV1Parser |
Includes only one of the fields |
cloudLoggingParser |
Includes only one of the fields |
tskvParser |
Includes only one of the fields |
GenericParserCommon
Field |
Description |
dataSchema |
|
nullKeysAllowed |
bool Allow null keys, if no - null keys will be putted to unparsed data |
addRestColumn |
bool Will add _rest column for all unknown fields |
unescapeStringValues |
bool Unescape string values |
DataSchema
Field |
Description |
jsonFields |
string Includes only one of the fields |
fields |
Includes only one of the fields |
FieldList
Field |
Description |
fields[] |
Column schema |
ColSchema
Field |
Description |
name |
string |
type |
enum ColumnType
|
key |
bool |
required |
bool |
path |
string |
AuditTrailsV1Parser
Field |
Description |
Empty |
CloudLoggingParser
Field |
Description |
Empty |
KafkaSource
Field |
Description |
connection |
Connection settings |
auth |
Authentication settings |
securityGroups[] |
string Security groups |
topicName |
string Full source topic name |
transformer |
Data transformation rules |
parser |
Data parsing rules |
topicNames[] |
string List of 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 |
OnPremiseKafka
Field |
Description |
brokerUrls[] |
string Kafka broker URLs |
subnetId |
string Network interface for endpoint. If none will assume public ipv4 |
tlsMode |
TLS settings for broker connection. Disabled by default. |
KafkaAuth
Field |
Description |
sasl |
Authentication with SASL Includes only one of the fields |
noAuth |
No authentication Includes only one of the fields |
KafkaSaslSecurity
Field |
Description |
user |
string User name |
mechanism |
enum KafkaMechanism SASL mechanism for authentication
|
password |
Password for user |
NoAuth
No authentication
Field |
Description |
Empty |
DataTransformationOptions
Field |
Description |
cloudFunction |
string Cloud function |
numberOfRetries |
int64 Number of retries |
bufferSize |
string Buffer size for function |
bufferFlushInterval |
string Flush interval |
invocationTimeout |
string Invocation timeout |
serviceAccountId |
string Service account |
MongoSource
Field |
Description |
connection |
|
subnetId |
string |
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 |
bool Read mode for mongo client |
securityGroups[] |
string Security groups |
MongoConnection
Field |
Description |
connectionOptions |
Includes only one of the fields |
MongoConnectionOptions
Field |
Description |
mdbClusterId |
string Includes only one of the fields |
onPremise |
Includes only one of the fields |
user |
string User name |
password |
Password for user |
authSource |
string Database name associated with the credentials |
OnPremiseMongo
Field |
Description |
hosts[] |
string |
port |
int64 |
replicaSet |
string |
tlsMode |
MongoCollection
Field |
Description |
databaseName |
string |
collectionName |
string |
ClickhouseSource
Field |
Description |
connection |
|
includeTables[] |
string While 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 |
securityGroups[] |
string |
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 |
Includes only one of the fields |
mdbClusterId |
string Includes only one of the fields |
user |
string |
password |
|
database |
string Database |
OnPremiseClickhouse
Field |
Description |
shards[] |
|
httpPort |
int64 |
nativePort |
int64 |
tlsMode |
ClickhouseShard
Field |
Description |
name |
string |
hosts[] |
string |
MysqlTarget
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. |
password |
Password for database access. |
sqlMode |
string Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION. |
skipConstraintChecks |
bool Disable constraints checks Recommend to disable for increase replication speed, but if schema contain |
timezone |
string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from |
cleanupPolicy |
enum CleanupPolicy Cleanup policy Cleanup policy for activate, reactivate and reupload processes. Default is
|
serviceDatabase |
string Database schema for service table Default: db name. Here created technical tables (__tm_keeper, __tm_gtid_keeper). |
securityGroups[] |
string Security groups |
PostgresTarget
Field |
Description |
connection |
Database connection settings |
database |
string Database name |
user |
string User for database access. not required as may be in connection |
password |
Password for database access. |
cleanupPolicy |
enum CleanupPolicy Cleanup policy for activate, reactivate and reupload processes. Default is
|
securityGroups[] |
string Security groups |
ClickhouseTarget
Field |
Description |
connection |
|
subnetId |
string |
altNames[] |
Alternative table names in target |
cleanupPolicy |
enum ClickhouseCleanupPolicy
|
sharding |
|
clickhouseClusterName |
string Name of the ClickHouse cluster. For Managed ClickHouse that is name of |
securityGroups[] |
string |
AltName
Field |
Description |
fromName |
string Source table name |
toName |
string Target table name |
ClickhouseSharding
Field |
Description |
columnValueHash |
Includes only one of the fields |
customMapping |
Includes only one of the fields |
transferId |
Includes only one of the fields |
roundRobin |
Includes only one of the fields |
ColumnValueHash
Field |
Description |
columnName |
string |
ColumnValueMapping
Field |
Description |
columnName |
string |
mapping[] |
ValueToShard
Field |
Description |
columnValue |
|
shardName |
string |
ColumnValue
Field |
Description |
stringValue |
string Includes only one of the fields |
YdbTarget
Field |
Description |
database |
string Path in YDB where to store tables |
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 |
cleanupPolicy |
enum YdbCleanupPolicy Cleanup policy
|
subnetId |
string Network interface for endpoint. If none will assume public ipv4 |
saKeyContent |
string SA content |
securityGroups[] |
string Security groups |
isTableColumnOriented |
bool Should create column-oriented table (OLAP). By default it creates row-oriented |
defaultCompression |
enum YdbDefaultCompression Compression that will be used for default columns family on YDB table creation
|
KafkaTarget
Field |
Description |
connection |
Connection settings |
auth |
Authentication settings |
securityGroups[] |
string Security groups |
topicSettings |
Target topic settings |
serializer |
Data serialization format settings |
KafkaTargetTopicSettings
Field |
Description |
topic |
Full topic name Includes only one of the fields |
topicPrefix |
string Topic prefix Analogue of the Debezium setting database.server.name. Includes only one of the fields |
KafkaTargetTopic
Field |
Description |
topicName |
string Topic name |
saveTxOrder |
bool Save transactions order |
Serializer
Data serialization format
Field |
Description |
serializerAuto |
Select the serialization format automatically Includes only one of the fields |
serializerJson |
Serialize data in json format Includes only one of the fields |
serializerDebezium |
Serialize data in debezium format Includes only one of the fields |
SerializerAuto
Field |
Description |
Empty |
SerializerJSON
Field |
Description |
Empty |
SerializerDebezium
Field |
Description |
serializerParameters[] |
Settings of sterilization parameters as key-value pairs |
DebeziumSerializerParameter
Field |
Description |
key |
string Name of the serializer parameter |
value |
string Value of the serializer parameter |
MongoTarget
Field |
Description |
connection |
|
database |
string Database name |
cleanupPolicy |
enum CleanupPolicy
|
subnetId |
string |
securityGroups[] |
string Security groups |
MetrikaSource
Field |
Description |
counterIds[] |
int64 |
token |
|
streams[] |
MetrikaStream
Field |
Description |
type |
enum MetrikaStreamType
|
columns[] |
string |
YDSTarget
Field |
Description |
database |
string Database |
stream |
string Stream |
serviceAccountId |
string SA which has read access to the stream. |
saveTxOrder |
bool Save transaction order |
serializer |
Data serialization format |
endpoint |
string for dedicated db |
subnetId |
string Network interface for endpoint. If none will assume public ipv4 |
securityGroups[] |
string Security groups |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |