Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Data Transfer
  • Доступные трансферы
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Подготовка к трансферу
    • Настройка эндпоинтов
      • Управление эндпоинтами
      • Настройка эндпоинтов-источников
        • Apache Kafka®
        • AWS CloudTrail
        • BigQuery
        • ClickHouse
        • Eventhub
        • Greenplum®
        • MongoDB
        • MySQL
        • Oracle
        • PostgreSQL
        • S3
        • Yandex Data Streams
        • Yandex Managed Service for YDB
      • Настройка эндпоинтов-приемников
        • Apache Kafka®
        • ClickHouse
        • Greenplum®
        • MongoDB
        • MySQL
        • Object Storage
        • PostgreSQL
        • Yandex Managed Service for YDB
    • Управление трансфером
    • Работа с базами данных во время трансфера
    • Мониторинг состояния трансфера
  • Практические руководства
    • Все руководства
    • Перенос данных между кластерами Yandex Managed Service for Apache Kafka®
    • Поставка данных из Yandex Managed Service for Apache Kafka® в Yandex Managed Service for ClickHouse
    • Поставка данных из Yandex Managed Service for Apache Kafka® в Yandex Managed Service for YDB
    • Перенос базы данных в Yandex Managed Service for ClickHouse
    • Миграция базы данных в Yandex Managed Service for Greenplum®
    • Миграция базы данных из Greenplum® в ClickHouse
    • Миграция базы данных из Greenplum® в PostgreSQL
    • Миграция базы данных в Yandex Managed Service for MongoDB
    • Миграция базы данных в Yandex Managed Service for MySQL
    • Миграция базы данных из MySQL в ClickHouse
    • Поставка данных из Yandex Managed Service for MySQL в Yandex Managed Service for Apache Kafka®
    • Миграция базы данных из Yandex Managed Service for MySQL в MySQL
    • Миграция базы данных из Yandex Managed Service for MySQL в Yandex Object Storage
    • Миграция базы данных из Yandex Managed Service for MySQL в Yandex Managed Service for YDB
    • Миграция базы данных в Yandex Managed Service for PostgreSQL
    • Миграция базы данных из PostgreSQL в ClickHouse
    • Поставка данных из Yandex Managed Service for PostgreSQL в Yandex Managed Service for Apache Kafka®
    • Миграция базы данных из Yandex Managed Service for PostgreSQL в Yandex Object Storage
    • Поставка данных из Yandex Managed Service for PostgreSQL в Yandex Managed Service for YDB
    • Сохранение потока данных Yandex Data Streams в ClickHouse
    • Миграция данных из Yandex Data Streams в Yandex Object Storage
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Типы и жизненные циклы трансферов
    • Объекты, переносимые трансфером
    • Работа Yandex Data Transfer с источниками и приемниками
    • Операции над трансфером
    • Сеть в Yandex Data Transfer
    • Скорость копирования данных в Yandex Data Transfer
    • Захват изменения данных
    • Шардированное копирование
    • Какие задачи решает сервис
    • Квоты и лимиты
  • Решение проблем
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • EndpointService
      • TransferService
      • OperationService
    • REST (англ.)
      • Overview
      • Endpoint
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • Transfer
        • Overview
        • activate
        • create
        • deactivate
        • delete
        • get
        • list
        • update
  • Вопросы и ответы
  1. Справочник API
  2. REST (англ.)
  3. Transfer
  4. Overview

Data Transfer API, REST: Transfer methods

Статья создана
Yandex Cloud
  • JSON Representation
  • Methods

JSON Representation

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

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

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

              // `source.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`source.settings.mysqlSource.connection.onPremise.tlsMode`

            },
            "subnetId": "string"
          },
          // end of the list of possible fields`source.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": {

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

              // `source.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`source.settings.postgresSource.connection.onPremise.tlsMode`

            },
            "subnetId": "string"
          },
          // end of the list of possible fields`source.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",

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

                // `source.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`source.settings.mongoSource.connection.connectionOptions.onPremise.tlsMode`

              },
              "replicaSet": "string"
            },
            // end of the list of possible fields`source.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"
            },

            // `source.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": {

                // `source.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`source.settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode`

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

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

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

              // `source.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`source.settings.mysqlTarget.connection.onPremise.tlsMode`

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

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

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

              // `source.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`source.settings.postgresTarget.connection.onPremise.tlsMode`

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

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

            // `source.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": {

                // `source.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`source.settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode`

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

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

          // `source.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`source.settings.clickhouseTarget.sharding`

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

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

                // `source.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`source.settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode`

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

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

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

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

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

              // `target.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`target.settings.mysqlSource.connection.onPremise.tlsMode`

            },
            "subnetId": "string"
          },
          // end of the list of possible fields`target.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": {

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

              // `target.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`target.settings.postgresSource.connection.onPremise.tlsMode`

            },
            "subnetId": "string"
          },
          // end of the list of possible fields`target.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",

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

                // `target.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`target.settings.mongoSource.connection.connectionOptions.onPremise.tlsMode`

              },
              "replicaSet": "string"
            },
            // end of the list of possible fields`target.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"
            },

            // `target.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": {

                // `target.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`target.settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode`

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

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

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

              // `target.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`target.settings.mysqlTarget.connection.onPremise.tlsMode`

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

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

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

              // `target.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`target.settings.postgresTarget.connection.onPremise.tlsMode`

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

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

            // `target.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": {

                // `target.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`target.settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode`

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

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

          // `target.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`target.settings.clickhouseTarget.sharding`

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

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

                // `target.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`target.settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode`

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

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

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

Connection settings

Database connection settings

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

Managed cluster

Managed Service for MySQL cluster ID

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

Database port

Default: 3306.

source.
settings.
mysqlSource.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

source.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled
object
source.settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
enabled
object
source.settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
mysqlSource.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

source.
settings.
mysqlSource.
securityGroups[]
string

Security groups

source.
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.

source.
settings.
mysqlSource.
serviceDatabase
string

Database for service tables

Default: data source database. Here created technical tables (__tm_keeper, __tm_gtid_keeper).

source.
settings.
mysqlSource.
user
string

Username

User for database access.

source.
settings.
mysqlSource.
password
object

Password

Password for database access.

source.
settings.
mysqlSource.
password.
raw
string

Password

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

Database timezone

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

source.
settings.
mysqlSource.
objectTransferSettings
object

Schema migration

Select database objects to be transferred during activation or deactivation.

source.
settings.
mysqlSource.
objectTransferSettings.
view
string

Views

CREATE VIEW ...

source.
settings.
mysqlSource.
objectTransferSettings.
routine
string

Routines

CREATE PROCEDURE ... ; CREATE FUNCTION ... ;

source.
settings.
mysqlSource.
objectTransferSettings.
trigger
string

Triggers

CREATE TRIGGER ...

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

Connection settings

Database connection settings

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

Managed cluster

Managed Service for PostgreSQL cluster ID

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

Database port

Will be used if the cluster ID is not specified. Default: 6432.

source.
settings.
postgresSource.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

source.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled
object
source.settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
enabled
object
source.settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
postgresSource.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

source.
settings.
postgresSource.
securityGroups[]
string

Security groups

source.
settings.
postgresSource.
database
string

Database name

source.
settings.
postgresSource.
user
string

Username

User for database access.

source.
settings.
postgresSource.
password
object

Password

Password for database access.

source.
settings.
postgresSource.
password.
raw
string

Password

source.
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.

source.
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.

source.
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.

source.
settings.
postgresSource.
serviceSchema
string

Database schema for service tables

Default: public. Here created technical tables (__consumer_keeper, __data_transfer_mole_finder).

source.
settings.
postgresSource.
objectTransferSettings
object

Schema migration

Select database objects to be transferred during activation or deactivation.

source.
settings.
postgresSource.
objectTransferSettings.
sequence
string

Sequences

CREATE SEQUENCE ...

source.
settings.
postgresSource.
objectTransferSettings.
sequenceOwnedBy
string

Owned sequences

CREATE SEQUENCE ... OWNED BY ...

source.
settings.
postgresSource.
objectTransferSettings.
table
string

Tables

CREATE TABLE ...

source.
settings.
postgresSource.
objectTransferSettings.
primaryKey
string

Primary keys

ALTER TABLE ... ADD PRIMARY KEY ...

source.
settings.
postgresSource.
objectTransferSettings.
fkConstraint
string

Foreign keys

ALTER TABLE ... ADD FOREIGN KEY ...

source.
settings.
postgresSource.
objectTransferSettings.
defaultValues
string

Default values

ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ...

source.
settings.
postgresSource.
objectTransferSettings.
constraint
string

Constraints

ALTER TABLE ... ADD CONSTRAINT ...

source.
settings.
postgresSource.
objectTransferSettings.
index
string

Indexes

CREATE INDEX ...

source.
settings.
postgresSource.
objectTransferSettings.
view
string

Views

CREATE VIEW ...

source.
settings.
postgresSource.
objectTransferSettings.
function
string

Functions

CREATE FUNCTION ...

source.
settings.
postgresSource.
objectTransferSettings.
trigger
string

Triggers

CREATE TRIGGER ...

source.
settings.
postgresSource.
objectTransferSettings.
type
string

Types

CREATE TYPE ...

source.
settings.
postgresSource.
objectTransferSettings.
rule
string

Rules

CREATE RULE ...

source.
settings.
postgresSource.
objectTransferSettings.
collation
string

Collations

CREATE COLLATION ...

source.
settings.
postgresSource.
objectTransferSettings.
policy
string

Policies

CREATE POLICY ...

source.
settings.
postgresSource.
objectTransferSettings.
cast
string

Casts

CREATE CAST ...

source.
settings.
postgresSource.
objectTransferSettings.
materializedView
string

Materialized views

CREATE MATERIALIZED VIEW ...

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

Password

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

Empty JSON object {}.

source.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.mongoSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
source.settings.mongoSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
replicaSet
string
source.
settings.
mongoSource.
subnetId
string
source.
settings.
mongoSource.
securityGroups[]
string

Security groups

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

Password

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

Empty JSON object {}.

source.
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
source.settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
clickhouseSource.
subnetId
string
source.
settings.
clickhouseSource.
securityGroups[]
string
source.
settings.
clickhouseSource.
includeTables[]
string
source.
settings.
clickhouseSource.
excludeTables[]
string
source.
settings.
mysqlTarget
object
source.settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
source.
settings.
mysqlTarget.
connection
object

Connection settings

Database connection settings

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

Managed cluster

Managed Service for MySQL cluster ID

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

Database port

Default: 3306.

source.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

source.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled
object
source.settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
enabled
object
source.settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
mysqlTarget.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

source.
settings.
mysqlTarget.
securityGroups[]
string

Security groups

source.
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.

source.
settings.
mysqlTarget.
user
string

Username

User for database access.

source.
settings.
mysqlTarget.
password
object

Password

Password for database access.

source.
settings.
mysqlTarget.
password.
raw
string

Password

source.
settings.
mysqlTarget.
sqlMode
string

sql_mode

Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION.

source.
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.

source.
settings.
mysqlTarget.
timezone
string

Database timezone

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

source.
settings.
mysqlTarget.
cleanupPolicy
string

Cleanup policy

Cleanup policy for activate, reactivate and reupload processes. Default is DISABLED.

source.
settings.
mysqlTarget.
serviceDatabase
string

Database schema for service table

Default: db name. Here created technical tables (__tm_keeper, __tm_gtid_keeper).

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

Connection settings

Database connection settings

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

Managed cluster

Managed Service for PostgreSQL cluster ID

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

Database port

Will be used if the cluster ID is not specified. Default: 6432.

source.
settings.
postgresTarget.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

source.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled
object
source.settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
enabled
object
source.settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
postgresTarget.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

source.
settings.
postgresTarget.
securityGroups[]
string

Security groups

source.
settings.
postgresTarget.
database
string

Database name

source.
settings.
postgresTarget.
user
string

Username

User for database access.

source.
settings.
postgresTarget.
password
object

Password

Password for database access.

source.
settings.
postgresTarget.
password.
raw
string

Password

source.
settings.
postgresTarget.
cleanupPolicy
string

Cleanup policy

Cleanup policy for activate, reactivate and reupload processes. Default is DISABLED.

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

Password

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

Empty JSON object {}.

source.
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
source.settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
clickhouseTarget.
subnetId
string
source.
settings.
clickhouseTarget.
securityGroups[]
string
source.
settings.
clickhouseTarget.
clickhouseClusterName
string
source.
settings.
clickhouseTarget.
altNames[]
object
source.
settings.
clickhouseTarget.
altNames[].
fromName
string

From table name

source.
settings.
clickhouseTarget.
altNames[].
toName
string

To table name

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

Empty JSON object {}.

source.
settings.
clickhouseTarget.
sharding.
transferId.
transferId
object
source.settings.clickhouseTarget.sharding includes only one of the fields columnValueHash, customMapping, transferId

Empty JSON object {}.

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

Password

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

Empty JSON object {}.

source.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
source.settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

source.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
source.settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
source.
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.

source.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
replicaSet
string
source.
settings.
mongoTarget.
subnetId
string
source.
settings.
mongoTarget.
securityGroups[]
string

Security groups

source.
settings.
mongoTarget.
database
string
source.
settings.
mongoTarget.
cleanupPolicy
string
target object
target.
id
string
target.
folderId
string
target.
name
string
target.
description
string
target.
labels
object
target.
settings
object
target.
settings.
mysqlSource
object
target.settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
target.
settings.
mysqlSource.
connection
object

Connection settings

Database connection settings

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

Managed cluster

Managed Service for MySQL cluster ID

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

Database port

Default: 3306.

target.
settings.
mysqlSource.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

target.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled
object
target.settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
enabled
object
target.settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
mysqlSource.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

target.
settings.
mysqlSource.
securityGroups[]
string

Security groups

target.
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.

target.
settings.
mysqlSource.
serviceDatabase
string

Database for service tables

Default: data source database. Here created technical tables (__tm_keeper, __tm_gtid_keeper).

target.
settings.
mysqlSource.
user
string

Username

User for database access.

target.
settings.
mysqlSource.
password
object

Password

Password for database access.

target.
settings.
mysqlSource.
password.
raw
string

Password

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

Database timezone

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

target.
settings.
mysqlSource.
objectTransferSettings
object

Schema migration

Select database objects to be transferred during activation or deactivation.

target.
settings.
mysqlSource.
objectTransferSettings.
view
string

Views

CREATE VIEW ...

target.
settings.
mysqlSource.
objectTransferSettings.
routine
string

Routines

CREATE PROCEDURE ... ; CREATE FUNCTION ... ;

target.
settings.
mysqlSource.
objectTransferSettings.
trigger
string

Triggers

CREATE TRIGGER ...

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

Connection settings

Database connection settings

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

Managed cluster

Managed Service for PostgreSQL cluster ID

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

Database port

Will be used if the cluster ID is not specified. Default: 6432.

target.
settings.
postgresSource.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

target.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled
object
target.settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
enabled
object
target.settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
postgresSource.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

target.
settings.
postgresSource.
securityGroups[]
string

Security groups

target.
settings.
postgresSource.
database
string

Database name

target.
settings.
postgresSource.
user
string

Username

User for database access.

target.
settings.
postgresSource.
password
object

Password

Password for database access.

target.
settings.
postgresSource.
password.
raw
string

Password

target.
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.

target.
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.

target.
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.

target.
settings.
postgresSource.
serviceSchema
string

Database schema for service tables

Default: public. Here created technical tables (__consumer_keeper, __data_transfer_mole_finder).

target.
settings.
postgresSource.
objectTransferSettings
object

Schema migration

Select database objects to be transferred during activation or deactivation.

target.
settings.
postgresSource.
objectTransferSettings.
sequence
string

Sequences

CREATE SEQUENCE ...

target.
settings.
postgresSource.
objectTransferSettings.
sequenceOwnedBy
string

Owned sequences

CREATE SEQUENCE ... OWNED BY ...

target.
settings.
postgresSource.
objectTransferSettings.
table
string

Tables

CREATE TABLE ...

target.
settings.
postgresSource.
objectTransferSettings.
primaryKey
string

Primary keys

ALTER TABLE ... ADD PRIMARY KEY ...

target.
settings.
postgresSource.
objectTransferSettings.
fkConstraint
string

Foreign keys

ALTER TABLE ... ADD FOREIGN KEY ...

target.
settings.
postgresSource.
objectTransferSettings.
defaultValues
string

Default values

ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ...

target.
settings.
postgresSource.
objectTransferSettings.
constraint
string

Constraints

ALTER TABLE ... ADD CONSTRAINT ...

target.
settings.
postgresSource.
objectTransferSettings.
index
string

Indexes

CREATE INDEX ...

target.
settings.
postgresSource.
objectTransferSettings.
view
string

Views

CREATE VIEW ...

target.
settings.
postgresSource.
objectTransferSettings.
function
string

Functions

CREATE FUNCTION ...

target.
settings.
postgresSource.
objectTransferSettings.
trigger
string

Triggers

CREATE TRIGGER ...

target.
settings.
postgresSource.
objectTransferSettings.
type
string

Types

CREATE TYPE ...

target.
settings.
postgresSource.
objectTransferSettings.
rule
string

Rules

CREATE RULE ...

target.
settings.
postgresSource.
objectTransferSettings.
collation
string

Collations

CREATE COLLATION ...

target.
settings.
postgresSource.
objectTransferSettings.
policy
string

Policies

CREATE POLICY ...

target.
settings.
postgresSource.
objectTransferSettings.
cast
string

Casts

CREATE CAST ...

target.
settings.
postgresSource.
objectTransferSettings.
materializedView
string

Materialized views

CREATE MATERIALIZED VIEW ...

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

Password

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

Empty JSON object {}.

target.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.mongoSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
target.settings.mongoSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
mongoSource.
connection.
connectionOptions.
onPremise.
replicaSet
string
target.
settings.
mongoSource.
subnetId
string
target.
settings.
mongoSource.
securityGroups[]
string

Security groups

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

Password

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

Empty JSON object {}.

target.
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
clickhouseSource.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
target.settings.clickhouseSource.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
clickhouseSource.
subnetId
string
target.
settings.
clickhouseSource.
securityGroups[]
string
target.
settings.
clickhouseSource.
includeTables[]
string
target.
settings.
clickhouseSource.
excludeTables[]
string
target.
settings.
mysqlTarget
object
target.settings includes only one of the fields mysqlSource, postgresSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, mongoTarget
target.
settings.
mysqlTarget.
connection
object

Connection settings

Database connection settings

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

Managed cluster

Managed Service for MySQL cluster ID

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

Database port

Default: 3306.

target.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

target.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled
object
target.settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
enabled
object
target.settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
mysqlTarget.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

target.
settings.
mysqlTarget.
securityGroups[]
string

Security groups

target.
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.

target.
settings.
mysqlTarget.
user
string

Username

User for database access.

target.
settings.
mysqlTarget.
password
object

Password

Password for database access.

target.
settings.
mysqlTarget.
password.
raw
string

Password

target.
settings.
mysqlTarget.
sqlMode
string

sql_mode

Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION.

target.
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.

target.
settings.
mysqlTarget.
timezone
string

Database timezone

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

target.
settings.
mysqlTarget.
cleanupPolicy
string

Cleanup policy

Cleanup policy for activate, reactivate and reupload processes. Default is DISABLED.

target.
settings.
mysqlTarget.
serviceDatabase
string

Database schema for service table

Default: db name. Here created technical tables (__tm_keeper, __tm_gtid_keeper).

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

Connection settings

Database connection settings

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

Managed cluster

Managed Service for PostgreSQL cluster ID

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

Database port

Will be used if the cluster ID is not specified. Default: 6432.

target.
settings.
postgresTarget.
connection.
onPremise.
tlsMode
object

TLS mode

TLS settings for server connection. Disabled by default.

target.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled
object
target.settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
enabled
object
target.settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
postgresTarget.
connection.
onPremise.
subnetId
string

Network interface for endpoint

Default: public IPv4.

target.
settings.
postgresTarget.
securityGroups[]
string

Security groups

target.
settings.
postgresTarget.
database
string

Database name

target.
settings.
postgresTarget.
user
string

Username

User for database access.

target.
settings.
postgresTarget.
password
object

Password

Password for database access.

target.
settings.
postgresTarget.
password.
raw
string

Password

target.
settings.
postgresTarget.
cleanupPolicy
string

Cleanup policy

Cleanup policy for activate, reactivate and reupload processes. Default is DISABLED.

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

Password

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

Empty JSON object {}.

target.
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
clickhouseTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
target.settings.clickhouseTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
clickhouseTarget.
subnetId
string
target.
settings.
clickhouseTarget.
securityGroups[]
string
target.
settings.
clickhouseTarget.
clickhouseClusterName
string
target.
settings.
clickhouseTarget.
altNames[]
object
target.
settings.
clickhouseTarget.
altNames[].
fromName
string

From table name

target.
settings.
clickhouseTarget.
altNames[].
toName
string

To table name

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

Empty JSON object {}.

target.
settings.
clickhouseTarget.
sharding.
transferId.
transferId
object
target.settings.clickhouseTarget.sharding includes only one of the fields columnValueHash, customMapping, transferId

Empty JSON object {}.

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

Password

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

Empty JSON object {}.

target.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
disabled.
disabled
object
target.settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.

target.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
tlsMode.
enabled
object
target.settings.mongoTarget.connection.connectionOptions.onPremise.tlsMode includes only one of the fields disabled, enabled
target.
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.

target.
settings.
mongoTarget.
connection.
connectionOptions.
onPremise.
replicaSet
string
target.
settings.
mongoTarget.
subnetId
string
target.
settings.
mongoTarget.
securityGroups[]
string

Security groups

target.
settings.
mongoTarget.
database
string
target.
settings.
mongoTarget.
cleanupPolicy
string
status string
type string
  • SNAPSHOT_AND_INCREMENT: Snapshot and increment
  • SNAPSHOT_ONLY: Snapshot
  • INCREMENT_ONLY: Increment
warning string

Methods

Method Description
activate
create
deactivate
delete
get
list
update

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • JSON Representation
  • Methods