package yb.cdc
Get desktop application:
View/edit binary Protocol Buffers messages
service CDCService
cdc_service.proto:49rpc CreateCDCStream (, )
cdc_service.proto:50message
cdc_service.proto:241optional string table_id = 1
Table to set up CDC on.
optional CDCRecordType record_type = 2
optional CDCRecordFormat record_format = 3
optional string namespace_name = 4
optional CDCRequestSource source_type = 5
optional CDCCheckpointType checkpoint_type = 6
optional bool transactional = 7
[default = false]
optional YQLDatabase db_type = 8
optional CDCSDKSnapshotOption cdcsdk_consistent_snapshot_option = 9
optional cdcsdk_stream_create_options = 10
cdcsdk_stream_create_options field should be used for adding more stream creation options related to CDCSDK in future.
message
cdc_service.proto:257optional error = 1
optional bytes stream_id = 2
optional bytes db_stream_id = 3
rpc DeleteCDCStream (, )
cdc_service.proto:51message
cdc_service.proto:263repeated bytes stream_id = 1
optional bool ignore_errors = 2
optional bool force_delete = 3
message
cdc_service.proto:269optional error = 1
rpc ListTablets (, )
cdc_service.proto:52message
cdc_service.proto:273optional string stream_id = 1
optional bool local_only = 2
local_only = true will only list tablets local to the tserver that receives the request. local_only = false will list all tablets for the stream.
message
cdc_service.proto:280optional error = 1
repeated tablets = 2
rpc GetChanges (, )
cdc_service.proto:53message
cdc_service.proto:318optional bytes stream_id = 1
optional bytes tablet_id = 2
Tablet to get the changes for.
optional from_checkpoint = 3
Checkpoint to start reading from (exclusive). Start reading from the first record after this checkpoint.
optional uint32 max_records = 4
Maximum records to read.
optional bool serve_as_proxy = 5
Whether the caller knows the tablet address or needs to use us as a proxy.
optional bytes db_stream_id = 6
optional bytes table_id = 7
optional from_cdc_sdk_checkpoint = 8
optional bool need_schema_info = 9
optional explicit_cdc_sdk_checkpoint = 10
This will be the checkpoint used for 'EXPLICIT' checkpoint streams.
optional int64 safe_hybrid_time = 11
optional int32 wal_segment_index = 12
index used to filter out the records we've already streamed.
optional uint32 auto_flags_config_version = 13
Used only in xCluster streams.
optional CDCSDKRequestSource cdcsdk_request_source = 14
optional int64 raft_config_opid_index = 15
optional uint64 getchanges_resp_max_size_bytes = 16
Used only in CDCSDK streams. If the field is set, use its value to limit the size of GetChanges response. Otherwise consider the value of the gflag 'cdc_stream_records_threshold_size_bytes'
message
cdc_service.proto:548optional error = 1
optional CDCRecordType record_type = 2
optional CDCRecordFormat record_format = 3
repeated records = 4
optional checkpoint = 5
Checkpoint that consumers can send back in GetChanges RPC to mark all CDC records in this GetChanges batch as committed.
repeated tserver = 6
In case the tablet is no longer hosted on this tserver, provide the list of tservers holding data for the tablet.
repeated cdc_sdk_proto_records = 8
repeated CDCSDKRecordPB cdc_sdk_records = 7;
optional cdc_sdk_checkpoint = 9
In addition to the op id info, cdc_sdk_checkpoint also stores the info about write_id and reverse_index_key so that it could be used to resume partially streamed intents
optional int64 safe_hybrid_time = 10
The safe time to be used on the target for this tablet.
optional int32 wal_segment_index = 11
index used to filter out the records we've already streamed.
optional uint32 auto_flags_config_version = 12
Only set in xCluster streams when error is AUTO_FLAGS_CONFIG_VERSION_MISMATCH.
optional tablet_consensus_info = 13
rpc GetCheckpoint (, )
cdc_service.proto:54message
cdc_service.proto:581optional bytes stream_id = 1
optional bytes tablet_id = 2
optional bytes table_id = 3
The table_id will be required in case of colocated tables.
optional bool serve_as_proxy = 4
Whether the caller knows the tablet address or needs to use us as a proxy.
message
cdc_service.proto:590optional error = 1
optional checkpoint = 2
optional bytes snapshot_key = 3
The snapshot_key and snapshot_time will be used for CDCSDK snapshot purposes.
optional uint64 snapshot_time = 4
message
cdc_service.proto:598optional bytes tablet_id = 1
Old API. Deprecated.
optional int64 replicated_index = 2
optional int64 replicated_term = 3
repeated bytes tablet_ids = 4
Batch API. Tablets being updated.
repeated int64 replicated_indices = 5
Minimum replicated index for each tablet across all the streams.
repeated int64 replicated_terms = 6
repeated cdc_sdk_consumed_ops = 7
Minimum checkpoint term and index for CDCSDK stream, to do intent cleanup for this tablet.
repeated uint64 cdc_sdk_ops_expiration_ms = 8
repeated bytes stream_ids = 9
optional fixed64 cdc_sdk_safe_time = 10
repeated fixed64 cdc_sdk_safe_times = 11
optional bool initial_retention_barrier = 12
Is this an initial retention barrier setting request
message
cdc_service.proto:619optional error = 1
message
cdc_service.proto:623repeated string table_ids = 1
repeated bytes xrepl_stream_ids = 2
If the stream_ids are not provided, a new stream for each table will be created.
optional bool check_if_bootstrap_required = 3
Check if data bootstrap is required. Equivalent to the IsBootstrapRequired RPC.
[default = false]
message
cdc_service.proto:631optional error = 1
repeated bytes cdc_bootstrap_ids = 2
New streams that were created. Only happens if the request does not have xrepl_stream_ids.
optional fixed64 bootstrap_time = 3
Minimum time after which data is available on all the bootstrapped streams.
optional bool bootstrap_required = 4
Only set if check_if_bootstrap_required is set on the request.
[default = false]
message
cdc_service.proto:641optional bytes tablet_id = 1
Deprecated.
repeated bytes tablet_ids = 2
Batch param.
message
cdc_service.proto:646optional error = 1
optional op_id = 2
Deprecated.
repeated op_ids = 3
Batch param.
optional fixed64 bootstrap_time = 4
message
cdc_service.proto:659optional bytes db_stream_id = 1
message
cdc_service.proto:663optional error = 1
optional bytes namespace_id = 2
repeated table_info = 3
repeated unqualified_table_info = 4
rpc SetCDCCheckpoint (, )
cdc_service.proto:62message
cdc_service.proto:670optional checkpoint = 1
optional cdc_sdk_checkpoint = 2
optional bytes stream_id = 3
optional bytes tablet_id = 4
optional bool initial_checkpoint = 5
optional bool bootstrap = 6
optional fixed64 cdc_sdk_safe_time = 7
optional bool serve_as_proxy = 8
Whether the caller knows the tablet address or needs to use us as a proxy.
message
cdc_service.proto:682optional error = 1
message
cdc_service.proto:691optional table_info = 1
optional bytes tablet_id = 2
message
cdc_service.proto:696optional error = 1
repeated tablet_checkpoint_pairs = 2
message
cdc_service.proto:701repeated string tablet_ids = 1
optional string stream_id = 2
message
cdc_service.proto:706optional error = 1
optional bool bootstrap_required = 2
message
cdc_service.proto:717repeated stream_info = 1
optional uint64 target_time = 2
message
cdc_service.proto:722optional error = 1
repeated drained_stream_info = 2
message
cdc_service.proto:167optional uint64 session_id = 1
optional bytes stream_id = 2
repeated string table_id = 3
optional slot_hash_range = 4
Represents the hash range constraints for replication slot i.e [start range, end range). Tablets with start hash range falling in these slot's hash range will be polled.
optional uint64 active_pid = 5
message
cdc_service.proto:177optional error = 1
rpc GetLagMetrics (, )
cdc_service.proto:71message
cdc_service.proto:181optional bytes stream_id = 1
message
cdc_service.proto:185optional error = 1
optional int64 lag_metric = 2
message
cdc_service.proto:190optional uint64 session_id = 1
optional bytes stream_id = 2
message
cdc_service.proto:195optional error = 1
repeated cdc_sdk_proto_records = 2
optional bool needs_publication_table_list_refresh = 3
This field tells the walsender whether a refresh of publication's table list is needed
optional uint64 publication_refresh_time = 4
This field tells the walsender the time at which the list of tables in the publication needs to be querried for refresh. This is only relevant if the above field 'needs_publication_table_list_refresh' is true.
message
cdc_service.proto:208optional uint64 session_id = 1
message
cdc_service.proto:212optional error = 1
message
cdc_service.proto:216optional uint64 session_id = 1
optional bytes stream_id = 2
optional uint64 confirmed_flush_lsn = 3
optional uint64 restart_lsn = 4
The hint given for the possible value of restart_lsn. The actual value which is persisted might differ from this value and is returned in the response of this RPC.
message
cdc_service.proto:226optional error = 1
optional uint64 restart_lsn = 2
message
cdc_service.proto:231optional uint64 session_id = 1
optional bytes stream_id = 2
repeated string table_id = 3
message
cdc_service.proto:237optional error = 1
message
cdc_service.proto:307Used in: , , ,
optional op_id = 1
Used in:
IMPLICIT = 1
Used for 2DC and CDC
EXPLICIT = 2
Used for CDC
message
cdc_service.proto:80Used in: , , , , , , , , , , , , , , , , , ,
optional CDCErrorPB.Code code = 1
The error code.
optional status = 2
The Status object for the error. This will include a textual message that may be more useful to present in log messages, etc, though its error code is less specific.
Used in:
UNKNOWN_ERROR = 1
An error which has no more specific error code. The code and message in 'status' may reveal more details. RPCs should avoid returning this, since callers will not be able to easily parse the error.
TABLET_NOT_FOUND = 2
TABLE_NOT_FOUND = 3
SUBSCRIBER_NOT_FOUND = 4
CHECKPOINT_TOO_OLD = 5
TABLET_NOT_RUNNING = 6
NOT_LEADER = 7
deprecated. use TABLET_NOT_FOUND
LEADER_NOT_READY = 11
NOT_RUNNING = 8
INTERNAL_ERROR = 9
INVALID_REQUEST = 10
TABLET_SPLIT = 12
OPERATION_DISALLOWED = 13
AUTO_FLAGS_CONFIG_VERSION_MISMATCH = 14
Used in: ,
JSON = 1
WAL = 2
Used for 2DC.
PROTO = 3
Used for CDCSDK in case of Debezium
message
cdc_service.proto:367Used in:
optional uint64 time = 1
optional CDCRecordPB.OperationType operation = 2
repeated key = 3
Primary key of the record that changed
repeated changes = 4
Key-value pairs (column_name : value) of changes / before record / after record
repeated before = 5
NOT CURRENTLY USED
repeated after = 6
NOT CURRENTLY USED
optional transaction_state = 7
optional partition = 9
If transaction_state.status is APPLYING, then partition will contain the partition for the tablet being polled.
optional split_tablet_request = 10
If operation type is a SPLIT_OP, then include the split request.
optional change_metadata_request = 11
If operation type is a CHANGE_METADATA_OP, then include the tablet payload for it.
optional uint32 subtransaction_id = 12
For intents, what subtransaction, if any, they are part of. Omitted in cases where the subtransaction ID is kMinSubTransactionId.
Used in:
WRITE = 1
DELETE = 2
APPLY = 3
SPLIT_OP = 4
CHANGE_METADATA = 5
Used in: ,
CHANGE = 1
CHANGE: Default type, only the changed columns as new image, no old image except DELETE
ALL = 3
ALL: [Old type that is no longer allowed to be created] same as PG_FULL
FULL_ROW_NEW_IMAGE = 4
FULL_ROW_NEW_IMAGE: [Old type that is no longer allowed to be created] Entire updated row as new image, entire row as old image for DELETE
MODIFIED_COLUMNS_OLD_AND_NEW_IMAGES = 5
MODIFIED_COLUMNS_OLD_AND_NEW_IMAGES: [Old type that is no longer allowed to be created] same as CHANGE_OLD_NEW
PG_FULL = 6
PG_FULL: Both old and new images of the entire row
PG_CHANGE_OLD_NEW = 7
PG_CHANGE_OLD_NEW: Both old and new image only of the modified columns
PG_DEFAULT = 8
PG_DEFAULT: Entire updated row as new image, only key as old image for DELETE
PG_NOTHING = 9
PG_NOTHING: No old image for any operation
Used in:
XCLUSTER = 1
Used for 2DC
CDCSDK = 2
Used for CDC
message
cdc_service.proto:295Used in: , , ,
optional int64 term = 1
optional int64 index = 2
optional bytes key = 3
write_id, key which is the reverse_index_iterator are used to resume from partially streamed intents when the number of intents to be streamed are more than the intent max batch size
optional int32 write_id = 4
optional uint64 snapshot_time = 5
snapshot_time is used in the context of bootstrap process
message
cdc_service.proto:406CDCSDK: Column information used in case of DDL, as part of schema info
Used in:
optional string name = 1
optional type = 2
optional bool is_key = 3
optional bool is_hash_key = 4
optional bool is_nullable = 5
optional int32 oid = 6
message
cdc_service.proto:431Used in:
optional int64 term = 1
The term of an operation or the leader's sequence id.
optional int64 index = 2
optional uint32 write_id = 3
optional bytes write_id_key = 4
message
cdc_service.proto:539Used in: ,
optional row_message = 1
optional cdc_sdk_op_id = 2
Op id information to identify duplicate entries
optional from_op_id = 3
Used in:
DEBEZIUM = 1
Debezium connector directly calling CDC Service.
WALSENDER = 2
Walsender calling CDC service.
message
cdc_service.proto:423CDCSDK: Schema information
Used in:
repeated column_info = 1
List of columns with associated column properties
optional tab_info = 2
Table properties
message
cdc_service.proto:416CDCSDK: Table properties used in case of DDL, as part of schema info
Used in:
optional uint64 default_time_to_live = 1
optional int32 num_tablets = 2
optional bool is_ysql_catalog_table = 3
message
cdc_service.proto:285Used in:
optional bytes tablet_id = 1
repeated tservers = 2
Tservers holding data for the tablet.
message
cdc_service.proto:286Used in:
repeated broadcast_addresses = 1
Don't use private_rpc_addresses since we're cross-universe
message
cdc_consumer.proto:91Used in: ,
map<string, > producer_map = 1
Map from ReplicationGroupId to metadata for that ReplicationGroup.
XClusterRole DEPRECATED_role = 3
Cannot remove the field, since we need to support rollbacks.
bool DEPRECATED_transactional = 4
Cannot remove the field, since we need to support rollbacks.
message
cdc_service.proto:362Used in:
optional bytes key = 1
optional value = 2
message
cdc_consumer.proto:72Used in:
map<string, > stream_map = 1
Map from stream id to metadata for that stream.
repeated master_addrs = 2
bool disable_stream = 4
[default = false] implicit in proto3
uint32 compatible_auto_flag_config_version = 5
[default = 0] implicit in proto3
uint32 validated_auto_flags_config_version = 6
[default = 0] implicit in proto3
bool automatic_ddl_mode = 7
Whether automatic ddl mode is enabled for all streams in this replication group.
message
cdc_consumer.proto:40Used in:
repeated string tablets = 1
List of tablet ids, start and end keys for a given producer table.
repeated bytes start_key = 2
repeated bytes end_key = 3
message
cdc_service.proto:162Used in:
optional uint32 start_range = 1
optional uint32 end_range = 2
message
cdc_service.proto:491Used in:
optional bytes transaction_id = 1
optional uint64 commit_time = 2
optional string table = 3
optional RowMessage.Op op = 4
repeated new_tuple = 5
repeated old_tuple = 6
repeated new_typeinfo = 7
optional schema = 8
Schema information used in case of DDL
optional uint32 schema_version = 9
Schema version
optional string new_table_name = 10
New table name, used in the case of rename table
optional string pgschema_name = 11
optional truncate_request_info = 13
truncate info
optional uint64 record_time = 14
optional uint64 pg_lsn = 15
optional uint32 pg_transaction_id = 16
optional string table_id = 17
The ID of the table associated with the row. Only populated for DMLs & DDLs but not for other ops such as BEGIN/COMMIT/SAFEPOINT.
optional bytes primary_key = 18
DocKey for the row in a table. Only populated for DMLs in the streaming phase but not for other ops such as DDL/BEGIN/COMMIT/SAFEPOINT. Not populated in the Snapshot phase.
Used in:
UNKNOWN = -1
INSERT = 0
UPDATE = 1
DELETE = 2
BEGIN = 3
COMMIT = 4
DDL = 5
TRUNCATE = 6
READ = 7
SAFEPOINT = 8
message
cdc_consumer.proto:47Used in: ,
uint32 current_producer_schema_version = 1
uint32 current_consumer_schema_version = 2
uint32 old_producer_schema_version = 3
uint32 old_consumer_schema_version = 4
message
cdc_consumer.proto:54Used in:
map<string, > consumer_producer_tablet_map = 1
Map from consumer to producer tablet id.
string consumer_table_id = 2
string producer_table_id = 3
bool local_tserver_optimized = 4
optional schema_versions = 6
Producer consumer schema versions
map<uint32, > colocated_schema_versions = 7
Mapping of colocation_id to producer/consumer schema versions
bool is_ddl_queue_table = 8
message
cdc_service.proto:712Metadata regarding replication status of a stream set up on a tablet.
Used in: ,
required bytes stream_id = 1
required bytes tablet_id = 2
message
cdc_service.proto:654Used in: ,
optional bytes stream_id = 1
optional bytes table_id = 2
message
cdc_service.proto:686Used in:
optional tablet_locations = 1
optional cdc_sdk_checkpoint = 2
message
cdc_service.proto:486Used in:
optional string modifier = 1
optional bool value_optional = 2
NOTE: Deprecated
Used in: ,
ACTIVE = 0
STANDBY = 1