Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Data Transfer

Method get

Written by

HTTP request

GET https://datatransfer.api.cloud.yandex.net/v1/endpoint/{endpointId}

Path parameters

Parameter Description
endpointId

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "settings": {

    // `settings` includes only one of the fields `mysqlSource`, `postgresSource`, `mongoSource`, `clickhouseSource`, `mysqlTarget`, `postgresTarget`, `clickhouseTarget`, `mongoTarget`
    "mysqlSource": {
      "connection": {

        // `settings.mysqlSource.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.mysqlSource.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.mysqlSource.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.mysqlSource.connection`

      },
      "securityGroups": [
        "string"
      ],
      "database": "string",
      "serviceDatabase": "string",
      "user": "string",
      "password": {
        "raw": "string"
      },
      "includeTablesRegex": [
        "string"
      ],
      "excludeTablesRegex": [
        "string"
      ],
      "timezone": "string",
      "objectTransferSettings": {
        "view": "string",
        "routine": "string",
        "trigger": "string"
      }
    },
    "postgresSource": {
      "connection": {

        // `settings.postgresSource.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.postgresSource.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.postgresSource.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.postgresSource.connection`

      },
      "securityGroups": [
        "string"
      ],
      "database": "string",
      "user": "string",
      "password": {
        "raw": "string"
      },
      "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"
      }
    },
    "mongoSource": {
      "connection": {
        "connectionOptions": {
          "user": "string",
          "password": {
            "raw": "string"
          },
          "authSource": "string",

          // `settings.mongoSource.connection.connectionOptions` includes only one of the fields `mdbClusterId`, `onPremise`
          "mdbClusterId": "string",
          "onPremise": {
            "hosts": [
              "string"
            ],
            "port": "string",
            "tlsMode": {

              // `settings.mongoSource.connection.connectionOptions.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
              "disabled": "object",
              "enabled": {
                "caCertificate": "string"
              },
              // end of the list of possible fields`settings.mongoSource.connection.connectionOptions.onPremise.tlsMode`

            },
            "replicaSet": "string"
          },
          // end of the list of possible fields`settings.mongoSource.connection.connectionOptions`

        }
      },
      "subnetId": "string",
      "securityGroups": [
        "string"
      ],
      "collections": [
        {
          "databaseName": "string",
          "collectionName": "string"
        }
      ],
      "excludedCollections": [
        {
          "databaseName": "string",
          "collectionName": "string"
        }
      ],
      "secondaryPreferredMode": true
    },
    "clickhouseSource": {
      "connection": {
        "connectionOptions": {
          "database": "string",
          "user": "string",
          "password": {
            "raw": "string"
          },

          // `settings.clickhouseSource.connection.connectionOptions` includes only one of the fields `mdbClusterId`, `onPremise`
          "mdbClusterId": "string",
          "onPremise": {
            "shards": [
              {
                "name": "string",
                "hosts": [
                  "string"
                ]
              }
            ],
            "httpPort": "string",
            "nativePort": "string",
            "tlsMode": {

              // `settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
              "disabled": "object",
              "enabled": {
                "caCertificate": "string"
              },
              // end of the list of possible fields`settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode`

            }
          },
          // end of the list of possible fields`settings.clickhouseSource.connection.connectionOptions`

        }
      },
      "subnetId": "string",
      "securityGroups": [
        "string"
      ],
      "includeTables": [
        "string"
      ],
      "excludeTables": [
        "string"
      ]
    },
    "mysqlTarget": {
      "connection": {

        // `settings.mysqlTarget.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.mysqlTarget.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.mysqlTarget.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.mysqlTarget.connection`

      },
      "securityGroups": [
        "string"
      ],
      "database": "string",
      "user": "string",
      "password": {
        "raw": "string"
      },
      "sqlMode": "string",
      "skipConstraintChecks": true,
      "timezone": "string",
      "cleanupPolicy": "string",
      "serviceDatabase": "string"
    },
    "postgresTarget": {
      "connection": {

        // `settings.postgresTarget.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.postgresTarget.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.postgresTarget.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.postgresTarget.connection`

      },
      "securityGroups": [
        "string"
      ],
      "database": "string",
      "user": "string",
      "password": {
        "raw": "string"
      },
      "cleanupPolicy": "string"
    },
    "clickhouseTarget": {
      "connection": {
        "connectionOptions": {
          "database": "string",
          "user": "string",
          "password": {
            "raw": "string"
          },

          // `settings.clickhouseTarget.connection.connectionOptions` includes only one of the fields `mdbClusterId`, `onPremise`
          "mdbClusterId": "string",
          "onPremise": {
            "shards": [
              {
                "name": "string",
                "hosts": [
                  "string"
                ]
              }
            ],
            "httpPort": "string",
            "nativePort": "string",
            "tlsMode": {

              // `settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
              "disabled": "object",
              "enabled": {
                "caCertificate": "string"
              },
              // end of the list of possible fields`settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode`

            }
          },
          // end of the list of possible fields`settings.clickhouseTarget.connection.connectionOptions`

        }
      },
      "subnetId": "string",
      "securityGroups": [
        "string"
      ],
      "clickhouseClusterName": "string",
      "altNames": [
        {
          "fromName": "string",
          "toName": "string"
        }
      ],
      "sharding": {

        // `settings.clickhouseTarget.sharding` includes only one of the fields `columnValueHash`, `customMapping`, `transferId`
        "columnValueHash": {
          "columnName": "string"
        },
        "customMapping": {
          "columnName": "string",
          "mapping": [
            {
              "columnValue": {
                "stringValue": "string"
              },
              "shardName": "string"
            }
          ]
        },
        "transferId": "object",
        // end of the list of possible fields`settings.clickhouseTarget.sharding`

      },
      "cleanupPolicy": "string"
    },
    "mongoTarget": {
      "connection": {
        "connectionOptions": {
          "user": "string",
          "password": {
            "raw": "string"
          },
          "authSource": "string",

          // `settings.mongoTarget.connection.connectionOptions` includes only one of the fields `mdbClusterId`, `onPremise`
          "mdbClusterId": "string",
          "onPremise": {
            "hosts": [
              "string"
            ],
            "port": "string",
            "tlsMode": {

              // `settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
              "disabled": "object",
              "enabled": {
                "caCertificate": "string"
              },
              // end of the list of possible fields`settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode`

            },
            "replicaSet": "string"
          },
          // end of the list of possible fields`settings.mongoTarget.connection.connectionOptions`

        }
      },
      "subnetId": "string",
      "securityGroups": [
        "string"
      ],
      "database": "string",
      "cleanupPolicy": "string"
    },
    // end of the list of possible fields`settings`

  }
}
Field Description
id string
folderId string
name string
description string
labels object
settings object
settings.
mysqlSource		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
mysqlSource.
connection		 object

Connection settings

Database connection settings
settings.
mysqlSource.
connection.
mdbClusterId		 string
settings.mysqlSource.connection includes only one of the fields mdbClusterId, onPremise

Managed cluster

Managed Service for MySQL cluster ID
settings.
mysqlSource.
connection.
onPremise		 object
On-premise Connection options for on-premise MySQL
settings.mysqlSource.connection includes only one of the fields mdbClusterId, onPremise
settings.
mysqlSource.
connection.
onPremise.
hosts[]		 string
settings.
mysqlSource.
connection.
onPremise.
port		 string (int64)

Database port

Default: 3306.
settings.
mysqlSource.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled		 object
settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
enabled		 object
settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
mysqlSource.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
mysqlSource.
securityGroups[]		 string

Security groups
settings.
mysqlSource.
database		 string

Database name

You can leave it empty, then it will be possible to transfer tables from several databases at the same time from this source.
settings.
mysqlSource.
serviceDatabase		 string

Database for service tables

Default: data source database. Here created technical tables (__tm_keeper, __tm_gtid_keeper).
settings.
mysqlSource.
user		 string

Username

User for database access.
settings.
mysqlSource.
password		 object

Password

Password for database access.
settings.
mysqlSource.
password.
raw		 string

Password
settings.
mysqlSource.
includeTablesRegex[]		 string
settings.
mysqlSource.
excludeTablesRegex[]		 string
settings.
mysqlSource.
timezone		 string

Database timezone

Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone.
settings.
mysqlSource.
objectTransferSettings		 object

Schema migration

Select database objects to be transferred during activation or deactivation.
settings.
mysqlSource.
objectTransferSettings.
view		 string

Views

CREATE VIEW ...
settings.
mysqlSource.
objectTransferSettings.
routine		 string

Routines

CREATE PROCEDURE ... ; CREATE FUNCTION ... ;
settings.
mysqlSource.
objectTransferSettings.
trigger		 string

Triggers

CREATE TRIGGER ...
settings.
postgresSource		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
postgresSource.
connection		 object

Connection settings

Database connection settings
settings.
postgresSource.
connection.
mdbClusterId		 string
settings.postgresSource.connection includes only one of the fields mdbClusterId, onPremise

Managed cluster

Managed Service for PostgreSQL cluster ID
settings.
postgresSource.
connection.
onPremise		 object
On-premise Connection options for on-premise PostgreSQL
settings.postgresSource.connection includes only one of the fields mdbClusterId, onPremise
settings.
postgresSource.
connection.
onPremise.
hosts[]		 string
settings.
postgresSource.
connection.
onPremise.
port		 string (int64)

Database port

Will be used if the cluster ID is not specified. Default: 6432.
settings.
postgresSource.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled		 object
settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
enabled		 object
settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
postgresSource.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
postgresSource.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
postgresSource.
securityGroups[]		 string

Security groups
settings.
postgresSource.
database		 string

Database name
settings.
postgresSource.
user		 string

Username

User for database access.
settings.
postgresSource.
password		 object

Password

Password for database access.
settings.
postgresSource.
password.
raw		 string

Password
settings.
postgresSource.
includeTables[]		 string

Included tables

If none or empty list is presented, all tables are replicated. Full table name with schema. Can contain schema_name.* patterns.
settings.
postgresSource.
excludeTables[]		 string

Excluded tables

If none or empty list is presented, all tables are replicated. Full table name with schema. Can contain schema_name.* patterns.
settings.
postgresSource.
slotByteLagLimit		 string (int64)

Maximum WAL size for the replication slot

Maximum WAL size held by the replication slot. Exceeding this limit will result in a replication failure and deletion of the replication slot. Unlimited by default.
settings.
postgresSource.
serviceSchema		 string

Database schema for service tables

Default: public. Here created technical tables (__consumer_keeper, __data_transfer_mole_finder).
settings.
postgresSource.
objectTransferSettings		 object

Schema migration

Select database objects to be transferred during activation or deactivation.
settings.
postgresSource.
objectTransferSettings.
sequence		 string

Sequences

CREATE SEQUENCE ...
settings.
postgresSource.
objectTransferSettings.
sequenceOwnedBy		 string

Owned sequences

CREATE SEQUENCE ... OWNED BY ...
settings.
postgresSource.
objectTransferSettings.
table		 string

Tables

CREATE TABLE ...
settings.
postgresSource.
objectTransferSettings.
primaryKey		 string

Primary keys

ALTER TABLE ... ADD PRIMARY KEY ...
settings.
postgresSource.
objectTransferSettings.
fkConstraint		 string

Foreign keys

ALTER TABLE ... ADD FOREIGN KEY ...
settings.
postgresSource.
objectTransferSettings.
defaultValues		 string

Default values

ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ...
settings.
postgresSource.
objectTransferSettings.
constraint		 string

Constraints

ALTER TABLE ... ADD CONSTRAINT ...
settings.
postgresSource.
objectTransferSettings.
index		 string

Indexes

CREATE INDEX ...
settings.
postgresSource.
objectTransferSettings.
view		 string

Views

CREATE VIEW ...
settings.
postgresSource.
objectTransferSettings.
function		 string

Functions

CREATE FUNCTION ...
settings.
postgresSource.
objectTransferSettings.
trigger		 string

Triggers

CREATE TRIGGER ...
settings.
postgresSource.
objectTransferSettings.
type		 string

Types

CREATE TYPE ...
settings.
postgresSource.
objectTransferSettings.
rule		 string

Rules

CREATE RULE ...
settings.
postgresSource.
objectTransferSettings.
collation		 string

Collations

CREATE COLLATION ...
settings.
postgresSource.
objectTransferSettings.
policy		 string

Policies

CREATE POLICY ...
settings.
postgresSource.
objectTransferSettings.
cast		 string

Casts

CREATE CAST ...
settings.
postgresSource.
objectTransferSettings.
materializedView		 string

Materialized views

CREATE MATERIALIZED VIEW ...
settings.
mongoSource		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
mongoSource.
connection		 object
settings.
mongoSource.
connection.
connectionOptions		 object
settings.
mongoSource.
connection.
connectionOptions.
user		 string
settings.
mongoSource.
connection.
connectionOptions.
password		 object
settings.
mongoSource.
connection.
connectionOptions.
password.
raw		 string

Password
settings.
mongoSource.
connection.
connectionOptions.
authSource		 string
settings.
mongoSource.
connection.
connectionOptions.
mdbClusterId		 string
settings.mongoSource.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
mongoSource.
connection.
connectionOptions.
onPremise		 object
settings.mongoSource.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
hosts[]		 string
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
port		 string (int64)
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode		 object
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled		 object
settings.mongoSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.mongoSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled		 object
settings.mongoSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
replicaSet		 string
settings.
mongoSource.
subnetId		 string
settings.
mongoSource.
securityGroups[]		 string

Security groups
settings.
mongoSource.
collections[]		 object
settings.
mongoSource.
collections[].
databaseName		 string
settings.
mongoSource.
collections[].
collectionName		 string
settings.
mongoSource.
excludedCollections[]		 object
settings.
mongoSource.
excludedCollections[].
databaseName		 string
settings.
mongoSource.
excludedCollections[].
collectionName		 string
settings.
mongoSource.
secondaryPreferredMode		 boolean (boolean)
settings.
clickhouseSource		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
clickhouseSource.
connection		 object
settings.
clickhouseSource.
connection.
connectionOptions		 object
settings.
clickhouseSource.
connection.
connectionOptions.
database		 string
settings.
clickhouseSource.
connection.
connectionOptions.
user		 string
settings.
clickhouseSource.
connection.
connectionOptions.
password		 object
settings.
clickhouseSource.
connection.
connectionOptions.
password.
raw		 string

Password
settings.
clickhouseSource.
connection.
connectionOptions.
mdbClusterId		 string
settings.clickhouseSource.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise		 object
settings.clickhouseSource.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
shards[]		 object
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
shards[].
name		 string
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
shards[].
hosts[]		 string
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
httpPort		 string (int64)
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
nativePort		 string (int64)
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode		 object
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled		 object
settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled		 object
settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
clickhouseSource.
subnetId		 string
settings.
clickhouseSource.
securityGroups[]		 string
settings.
clickhouseSource.
includeTables[]		 string
settings.
clickhouseSource.
excludeTables[]		 string
settings.
mysqlTarget		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
mysqlTarget.
connection		 object

Connection settings

Database connection settings
settings.
mysqlTarget.
connection.
mdbClusterId		 string
settings.mysqlTarget.connection includes only one of the fields mdbClusterId, onPremise

Managed cluster

Managed Service for MySQL cluster ID
settings.
mysqlTarget.
connection.
onPremise		 object
On-premise Connection options for on-premise MySQL
settings.mysqlTarget.connection includes only one of the fields mdbClusterId, onPremise
settings.
mysqlTarget.
connection.
onPremise.
hosts[]		 string
settings.
mysqlTarget.
connection.
onPremise.
port		 string (int64)

Database port

Default: 3306.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled		 object
settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
enabled		 object
settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
mysqlTarget.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
mysqlTarget.
securityGroups[]		 string

Security groups
settings.
mysqlTarget.
database		 string

Database name

Allowed to leave it empty, then the tables will be created in databases with the same names as on the source. If this field is empty, then you must fill below db schema for service table.
settings.
mysqlTarget.
user		 string

Username

User for database access.
settings.
mysqlTarget.
password		 object

Password

Password for database access.
settings.
mysqlTarget.
password.
raw		 string

Password
settings.
mysqlTarget.
sqlMode		 string

sql_mode

Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION.
settings.
mysqlTarget.
skipConstraintChecks		 boolean (boolean)

Disable constraints checks

Recommend to disable for increase replication speed, but if schema contain cascading operations we don't recommend to disable. This option set FOREIGN_KEY_CHECKS=0 and UNIQUE_CHECKS=0.
settings.
mysqlTarget.
timezone		 string

Database timezone

Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone.
settings.
mysqlTarget.
cleanupPolicy		 string

Cleanup policy

Cleanup policy for activate, reactivate and reupload processes. Default is DISABLED.
settings.
mysqlTarget.
serviceDatabase		 string

Database schema for service table

Default: db name. Here created technical tables (__tm_keeper, __tm_gtid_keeper).
settings.
postgresTarget		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
postgresTarget.
connection		 object

Connection settings

Database connection settings
settings.
postgresTarget.
connection.
mdbClusterId		 string
settings.postgresTarget.connection includes only one of the fields mdbClusterId, onPremise

Managed cluster

Managed Service for PostgreSQL cluster ID
settings.
postgresTarget.
connection.
onPremise		 object
On-premise Connection options for on-premise PostgreSQL
settings.postgresTarget.connection includes only one of the fields mdbClusterId, onPremise
settings.
postgresTarget.
connection.
onPremise.
hosts[]		 string
settings.
postgresTarget.
connection.
onPremise.
port		 string (int64)

Database port

Will be used if the cluster ID is not specified. Default: 6432.
settings.
postgresTarget.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled		 object
settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
enabled		 object
settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
postgresTarget.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
postgresTarget.
securityGroups[]		 string

Security groups
settings.
postgresTarget.
database		 string

Database name
settings.
postgresTarget.
user		 string

Username

User for database access.
settings.
postgresTarget.
password		 object

Password

Password for database access.
settings.
postgresTarget.
password.
raw		 string

Password
settings.
postgresTarget.
cleanupPolicy		 string

Cleanup policy

Cleanup policy for activate, reactivate and reupload processes. Default is DISABLED.
settings.
clickhouseTarget		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
clickhouseTarget.
connection		 object
settings.
clickhouseTarget.
connection.
connectionOptions		 object
settings.
clickhouseTarget.
connection.
connectionOptions.
database		 string
settings.
clickhouseTarget.
connection.
connectionOptions.
user		 string
settings.
clickhouseTarget.
connection.
connectionOptions.
password		 object
settings.
clickhouseTarget.
connection.
connectionOptions.
password.
raw		 string

Password
settings.
clickhouseTarget.
connection.
connectionOptions.
mdbClusterId		 string
settings.clickhouseTarget.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise		 object
settings.clickhouseTarget.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
shards[]		 object
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
shards[].
name		 string
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
shards[].
hosts[]		 string
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
httpPort		 string (int64)
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
nativePort		 string (int64)
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode		 object
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled		 object
settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled		 object
settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
clickhouseTarget.
subnetId		 string
settings.
clickhouseTarget.
securityGroups[]		 string
settings.
clickhouseTarget.
clickhouseClusterName		 string
settings.
clickhouseTarget.
altNames[]		 object
settings.
clickhouseTarget.
altNames[].
fromName		 string

From table name
settings.
clickhouseTarget.
altNames[].
toName		 string

To table name
settings.
clickhouseTarget.
sharding		 object
settings.
clickhouseTarget.
sharding.
columnValueHash		 object
settings.clickhouseTarget.sharding includes only one of the fields columnValueHash, customMapping, transferId
settings.
clickhouseTarget.
sharding.
columnValueHash.
columnName		 string
settings.
clickhouseTarget.
sharding.
customMapping		 object
settings.clickhouseTarget.sharding includes only one of the fields columnValueHash, customMapping, transferId
settings.
clickhouseTarget.
sharding.
customMapping.
columnName		 string
settings.
clickhouseTarget.
sharding.
customMapping.
mapping[]		 object
settings.
clickhouseTarget.
sharding.
customMapping.
mapping[].
columnValue		 object
settings.
clickhouseTarget.
sharding.
customMapping.
mapping[].
columnValue.
stringValue		 string
settings.
clickhouseTarget.
sharding.
customMapping.
mapping[].
shardName		 string
settings.
clickhouseTarget.
sharding.
transferId		 object
settings.clickhouseTarget.sharding includes only one of the fields columnValueHash, customMapping, transferId

Empty JSON object {}.
settings.
clickhouseTarget.
sharding.
transferId.
transferId		 object
settings.clickhouseTarget.sharding includes only one of the fields columnValueHash, customMapping, transferId

Empty JSON object {}.
settings.
clickhouseTarget.
cleanupPolicy		 string
settings.
mongoTarget		 object
settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
settings.
mongoTarget.
connection		 object
settings.
mongoTarget.
connection.
connectionOptions		 object
settings.
mongoTarget.
connection.
connectionOptions.
user		 string
settings.
mongoTarget.
connection.
connectionOptions.
password		 object
settings.
mongoTarget.
connection.
connectionOptions.
password.
raw		 string

Password
settings.
mongoTarget.
connection.
connectionOptions.
authSource		 string
settings.
mongoTarget.
connection.
connectionOptions.
mdbClusterId		 string
settings.mongoTarget.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
mongoTarget.
connection.
connectionOptions.
onPremise		 object
settings.mongoTarget.connection.connectionOptions includes only one of the fields mdbClusterId, onPremise
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
hosts[]		 string
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
port		 string (int64)
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode		 object
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled		 object
settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled		 object
settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
replicaSet		 string
settings.
mongoTarget.
subnetId		 string
settings.
mongoTarget.
securityGroups[]		 string

Security groups
settings.
mongoTarget.
database		 string
settings.
mongoTarget.
cleanupPolicy		 string
Language / Region
© 2022 Yandex.Cloud LLC
In this article: