EndpointService
Статья создана
- Calls EndpointService
- Get
- GetEndpointRequest
- Endpoint
- EndpointSettings
- MysqlSource
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- Secret
- MysqlObjectTransferSettings
- PostgresSource
- PostgresConnection
- OnPremisePostgres
- TLSMode
- TLSConfig
- Secret
- PostgresObjectTransferSettings
- MysqlTarget
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- Secret
- PostgresTarget
- PostgresConnection
- OnPremisePostgres
- TLSMode
- TLSConfig
- Secret
- Create
- CreateEndpointRequest
- EndpointSettings
- MysqlSource
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- Secret
- MysqlObjectTransferSettings
- PostgresSource
- PostgresConnection
- OnPremisePostgres
- TLSMode
- TLSConfig
- Secret
- PostgresObjectTransferSettings
- MysqlTarget
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- Secret
- PostgresTarget
- PostgresConnection
- OnPremisePostgres
- TLSMode
- TLSConfig
- Secret
- Operation
- Update
- UpdateEndpointRequest
- EndpointSettings
- MysqlSource
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- Secret
- MysqlObjectTransferSettings
- PostgresSource
- PostgresConnection
- OnPremisePostgres
- TLSMode
- TLSConfig
- Secret
- PostgresObjectTransferSettings
- MysqlTarget
- MysqlConnection
- OnPremiseMysql
- TLSMode
- TLSConfig
- Secret
- PostgresTarget
- PostgresConnection
- OnPremisePostgres
- TLSMode
- TLSConfig
- Secret
- Operation
- Delete
| Call | Description |
|---|---|
| Get | |
| Create | |
| Update | |
| Delete |
Calls EndpointService
Get
rpc Get (GetEndpointRequest) returns (Endpoint)
GetEndpointRequest
| Field | Description |
|---|---|
| endpoint_id | string |
Endpoint
| Field | Description |
|---|---|
| id | string |
| folder_id | string |
| name | string |
| description | string |
| settings | EndpointSettings |
EndpointSettings
| Field | Description |
|---|---|
| settings | oneof: mysql_source, postgres_source, mysql_target or postgres_target |
| mysql_source | endpoint.MysqlSource |
| postgres_source | endpoint.PostgresSource |
| mysql_target | endpoint.MysqlTarget |
| postgres_target | endpoint.PostgresTarget |
MysqlSource
| Field | Description |
|---|---|
| connection | MysqlConnection Connection settings Database connection settings |
| 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. |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| include_tables_regex[] | string |
| exclude_tables_regex[] | string |
| timezone | string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone. |
| object_transfer_settings | MysqlObjectTransferSettings Schema migration Select database objects to be transferred during activation or deactivation. |
MysqlConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed MySQL cluster ID |
| on_premise | OnPremiseMysql On-premise Connection options for on-premise MySQL |
OnPremiseMysql
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
MysqlObjectTransferSettings
| Field | Description |
|---|---|
| view | enum ObjectTransferStage Views CREATE VIEW ... |
| routine | enum ObjectTransferStage Routines CREATE PROCEDURE ...; CREATE FUNCTION ...; |
| trigger | enum ObjectTransferStage Triggers CREATE TRIGGER ... |
PostgresSource
| Field | Description |
|---|---|
| connection | PostgresConnection Connection settings Database connection settings |
| database | string Database name |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| include_tables[] | string List of tables If none or empty list is presented, all tables are replicated. Can contain regular expression. |
| exclude_tables[] | string Excluded tables If none or empty list is presented, all tables are replicated. Can contain regular expression. |
| slot_byte_lag_limit | 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. |
| service_schema | string Database schema for service table Default: public. Here created technical tables (__consumer_keeper, __data_transfer_mole_finder). |
| object_transfer_settings | PostgresObjectTransferSettings Schema migration Select database objects to be transferred during activation or deactivation. |
PostgresConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed PostgreSQL cluster ID |
| on_premise | OnPremisePostgres On-premise Connection options for on-premise PostgreSQL |
OnPremisePostgres
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
PostgresObjectTransferSettings
| Field | Description |
|---|---|
| sequence | enum ObjectTransferStage Sequences CREATE SEQUENCE ... |
| sequence_owned_by | enum ObjectTransferStage Owned sequences CREATE SEQUENCE ... OWNED BY ... |
| table | enum ObjectTransferStage Tables CREATE TABLE ... |
| primary_key | enum ObjectTransferStage Primary keys ALTER TABLE ... ADD PRIMARY KEY ... |
| fk_constraint | enum ObjectTransferStage Foreign keys ALTER TABLE ... ADD FOREIGN KEY ... |
| default_values | enum ObjectTransferStage Default values ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ... |
| constraint | enum ObjectTransferStage Constraints ALTER TABLE ... ADD CONSTRAINT ... |
| index | enum ObjectTransferStage Indexes CREATE INDEX ... |
| view | enum ObjectTransferStage Views CREATE VIEW ... |
| function | enum ObjectTransferStage Functions CREATE FUNCTION ... |
| trigger | enum ObjectTransferStage Triggers CREATE TRIGGER ... |
| type | enum ObjectTransferStage Types CREATE TYPE ... |
| rule | enum ObjectTransferStage Rules CREATE RULE ... |
| collation | enum ObjectTransferStage Collations CREATE COLLATION ... |
| policy | enum ObjectTransferStage Policies CREATE POLICY ... |
| cast | enum ObjectTransferStage Casts CREATE CAST ... |
MysqlTarget
| Field | Description |
|---|---|
| connection | MysqlConnection Connection settings Database connection settings |
| 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. |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| sql_mode | string sql_mode Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION. |
| skip_constraint_checks | bool 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. |
| timezone | string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone. |
MysqlConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed MySQL cluster ID |
| on_premise | OnPremiseMysql On-premise Connection options for on-premise MySQL |
OnPremiseMysql
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
PostgresTarget
| Field | Description |
|---|---|
| connection | PostgresConnection Connection settings Database connection settings |
| database | string Database name |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
PostgresConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed PostgreSQL cluster ID |
| on_premise | OnPremisePostgres On-premise Connection options for on-premise PostgreSQL |
OnPremisePostgres
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
Create
rpc Create (CreateEndpointRequest) returns (operation.Operation)
CreateEndpointRequest
| Field | Description |
|---|---|
| folder_id | string |
| name | string |
| description | string |
| settings | EndpointSettings |
EndpointSettings
| Field | Description |
|---|---|
| settings | oneof: mysql_source, postgres_source, mysql_target or postgres_target |
| mysql_source | endpoint.MysqlSource |
| postgres_source | endpoint.PostgresSource |
| mysql_target | endpoint.MysqlTarget |
| postgres_target | endpoint.PostgresTarget |
MysqlSource
| Field | Description |
|---|---|
| connection | MysqlConnection Connection settings Database connection settings |
| 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. |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| include_tables_regex[] | string |
| exclude_tables_regex[] | string |
| timezone | string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone. |
| object_transfer_settings | MysqlObjectTransferSettings Schema migration Select database objects to be transferred during activation or deactivation. |
MysqlConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed MySQL cluster ID |
| on_premise | OnPremiseMysql On-premise Connection options for on-premise MySQL |
OnPremiseMysql
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
MysqlObjectTransferSettings
| Field | Description |
|---|---|
| view | enum ObjectTransferStage Views CREATE VIEW ... |
| routine | enum ObjectTransferStage Routines CREATE PROCEDURE ...; CREATE FUNCTION ...; |
| trigger | enum ObjectTransferStage Triggers CREATE TRIGGER ... |
PostgresSource
| Field | Description |
|---|---|
| connection | PostgresConnection Connection settings Database connection settings |
| database | string Database name |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| include_tables[] | string List of tables If none or empty list is presented, all tables are replicated. Can contain regular expression. |
| exclude_tables[] | string Excluded tables If none or empty list is presented, all tables are replicated. Can contain regular expression. |
| slot_byte_lag_limit | 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. |
| service_schema | string Database schema for service table Default: public. Here created technical tables (__consumer_keeper, __data_transfer_mole_finder). |
| object_transfer_settings | PostgresObjectTransferSettings Schema migration Select database objects to be transferred during activation or deactivation. |
PostgresConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed PostgreSQL cluster ID |
| on_premise | OnPremisePostgres On-premise Connection options for on-premise PostgreSQL |
OnPremisePostgres
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
PostgresObjectTransferSettings
| Field | Description |
|---|---|
| sequence | enum ObjectTransferStage Sequences CREATE SEQUENCE ... |
| sequence_owned_by | enum ObjectTransferStage Owned sequences CREATE SEQUENCE ... OWNED BY ... |
| table | enum ObjectTransferStage Tables CREATE TABLE ... |
| primary_key | enum ObjectTransferStage Primary keys ALTER TABLE ... ADD PRIMARY KEY ... |
| fk_constraint | enum ObjectTransferStage Foreign keys ALTER TABLE ... ADD FOREIGN KEY ... |
| default_values | enum ObjectTransferStage Default values ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ... |
| constraint | enum ObjectTransferStage Constraints ALTER TABLE ... ADD CONSTRAINT ... |
| index | enum ObjectTransferStage Indexes CREATE INDEX ... |
| view | enum ObjectTransferStage Views CREATE VIEW ... |
| function | enum ObjectTransferStage Functions CREATE FUNCTION ... |
| trigger | enum ObjectTransferStage Triggers CREATE TRIGGER ... |
| type | enum ObjectTransferStage Types CREATE TYPE ... |
| rule | enum ObjectTransferStage Rules CREATE RULE ... |
| collation | enum ObjectTransferStage Collations CREATE COLLATION ... |
| policy | enum ObjectTransferStage Policies CREATE POLICY ... |
| cast | enum ObjectTransferStage Casts CREATE CAST ... |
MysqlTarget
| Field | Description |
|---|---|
| connection | MysqlConnection Connection settings Database connection settings |
| 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. |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| sql_mode | string sql_mode Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION. |
| skip_constraint_checks | bool 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. |
| timezone | string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone. |
MysqlConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed MySQL cluster ID |
| on_premise | OnPremiseMysql On-premise Connection options for on-premise MySQL |
OnPremiseMysql
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
PostgresTarget
| Field | Description |
|---|---|
| connection | PostgresConnection Connection settings Database connection settings |
| database | string Database name |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
PostgresConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed PostgreSQL cluster ID |
| on_premise | OnPremisePostgres On-premise Connection options for on-premise PostgreSQL |
OnPremisePostgres
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
Operation
| Field | Description |
|---|---|
| id | string ID of the operation. |
| description | string Description of the operation. 0-256 characters long. |
| created_at | google.protobuf.Timestamp Creation timestamp. |
| created_by | string ID of the user or service account who initiated the operation. |
| modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
| done | bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. |
| metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
| result | oneof: error or responseThe operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set. |
| error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
| response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |
Update
rpc Update (UpdateEndpointRequest) returns (operation.Operation)
UpdateEndpointRequest
| Field | Description |
|---|---|
| endpoint_id | string |
| name | string |
| description | string |
| settings | EndpointSettings |
EndpointSettings
| Field | Description |
|---|---|
| settings | oneof: mysql_source, postgres_source, mysql_target or postgres_target |
| mysql_source | endpoint.MysqlSource |
| postgres_source | endpoint.PostgresSource |
| mysql_target | endpoint.MysqlTarget |
| postgres_target | endpoint.PostgresTarget |
MysqlSource
| Field | Description |
|---|---|
| connection | MysqlConnection Connection settings Database connection settings |
| 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. |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| include_tables_regex[] | string |
| exclude_tables_regex[] | string |
| timezone | string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone. |
| object_transfer_settings | MysqlObjectTransferSettings Schema migration Select database objects to be transferred during activation or deactivation. |
MysqlConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed MySQL cluster ID |
| on_premise | OnPremiseMysql On-premise Connection options for on-premise MySQL |
OnPremiseMysql
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
MysqlObjectTransferSettings
| Field | Description |
|---|---|
| view | enum ObjectTransferStage Views CREATE VIEW ... |
| routine | enum ObjectTransferStage Routines CREATE PROCEDURE ...; CREATE FUNCTION ...; |
| trigger | enum ObjectTransferStage Triggers CREATE TRIGGER ... |
PostgresSource
| Field | Description |
|---|---|
| connection | PostgresConnection Connection settings Database connection settings |
| database | string Database name |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| include_tables[] | string List of tables If none or empty list is presented, all tables are replicated. Can contain regular expression. |
| exclude_tables[] | string Excluded tables If none or empty list is presented, all tables are replicated. Can contain regular expression. |
| slot_byte_lag_limit | 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. |
| service_schema | string Database schema for service table Default: public. Here created technical tables (__consumer_keeper, __data_transfer_mole_finder). |
| object_transfer_settings | PostgresObjectTransferSettings Schema migration Select database objects to be transferred during activation or deactivation. |
PostgresConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed PostgreSQL cluster ID |
| on_premise | OnPremisePostgres On-premise Connection options for on-premise PostgreSQL |
OnPremisePostgres
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
PostgresObjectTransferSettings
| Field | Description |
|---|---|
| sequence | enum ObjectTransferStage Sequences CREATE SEQUENCE ... |
| sequence_owned_by | enum ObjectTransferStage Owned sequences CREATE SEQUENCE ... OWNED BY ... |
| table | enum ObjectTransferStage Tables CREATE TABLE ... |
| primary_key | enum ObjectTransferStage Primary keys ALTER TABLE ... ADD PRIMARY KEY ... |
| fk_constraint | enum ObjectTransferStage Foreign keys ALTER TABLE ... ADD FOREIGN KEY ... |
| default_values | enum ObjectTransferStage Default values ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ... |
| constraint | enum ObjectTransferStage Constraints ALTER TABLE ... ADD CONSTRAINT ... |
| index | enum ObjectTransferStage Indexes CREATE INDEX ... |
| view | enum ObjectTransferStage Views CREATE VIEW ... |
| function | enum ObjectTransferStage Functions CREATE FUNCTION ... |
| trigger | enum ObjectTransferStage Triggers CREATE TRIGGER ... |
| type | enum ObjectTransferStage Types CREATE TYPE ... |
| rule | enum ObjectTransferStage Rules CREATE RULE ... |
| collation | enum ObjectTransferStage Collations CREATE COLLATION ... |
| policy | enum ObjectTransferStage Policies CREATE POLICY ... |
| cast | enum ObjectTransferStage Casts CREATE CAST ... |
MysqlTarget
| Field | Description |
|---|---|
| connection | MysqlConnection Connection settings Database connection settings |
| 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. |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
| sql_mode | string sql_mode Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION. |
| skip_constraint_checks | bool 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. |
| timezone | string Database timezone Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone. |
MysqlConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed MySQL cluster ID |
| on_premise | OnPremiseMysql On-premise Connection options for on-premise MySQL |
OnPremiseMysql
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
PostgresTarget
| Field | Description |
|---|---|
| connection | PostgresConnection Connection settings Database connection settings |
| database | string Database name |
| user | string Username User for database access. |
| password | Secret Password Password for database access. |
PostgresConnection
| Field | Description |
|---|---|
| connection | oneof: mdb_cluster_id or on_premise |
| mdb_cluster_id | string MDB cluster Yandex.Cloud Managed PostgreSQL cluster ID |
| on_premise | OnPremisePostgres On-premise Connection options for on-premise PostgreSQL |
OnPremisePostgres
| Field | Description |
|---|---|
| hosts[] | string |
| port | int64 Database port Will be used if the cluster ID is not specified. Default: 6432. |
| tls_mode | TLSMode TLS mode TLS settings for server connection. Disabled by default. |
| subnet_id | string Network interface for endpoint Default: public IPv4. |
TLSMode
| Field | Description |
|---|---|
| tls_mode | oneof: disabled or enabled |
| disabled | google.protobuf.Empty |
| enabled | TLSConfig |
TLSConfig
| Field | Description |
|---|---|
| ca_certificate | 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. |
Secret
| Field | Description |
|---|---|
| value | oneof: raw |
| raw | string Password |
Operation
| Field | Description |
|---|---|
| id | string ID of the operation. |
| description | string Description of the operation. 0-256 characters long. |
| created_at | google.protobuf.Timestamp Creation timestamp. |
| created_by | string ID of the user or service account who initiated the operation. |
| modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
| done | bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. |
| metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
| result | oneof: error or responseThe operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set. |
| error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
| response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |
Delete
rpc Delete (DeleteEndpointRequest) returns (operation.Operation)
DeleteEndpointRequest
| Field | Description |
|---|---|
| endpoint_id | string |
Operation
| Field | Description |
|---|---|
| id | string ID of the operation. |
| description | string Description of the operation. 0-256 characters long. |
| created_at | google.protobuf.Timestamp Creation timestamp. |
| created_by | string ID of the user or service account who initiated the operation. |
| modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
| done | bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. |
| metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
| result | oneof: error or responseThe operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set. |
| error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
| response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |