From 04809c2eb43d7ed58ea54f6b9fa5d287fbb23e8b Mon Sep 17 00:00:00 2001 From: Bob Roldan Date: Thu, 15 Sep 2022 12:57:07 -0400 Subject: [PATCH] DBZ-3327 Add values to empty table cells in Vitess and Cassandra docs --- .../ROOT/pages/connectors/cassandra.adoc | 16 +++++++------- .../modules/ROOT/pages/connectors/vitess.adoc | 22 +++++++++---------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/documentation/modules/ROOT/pages/connectors/cassandra.adoc b/documentation/modules/ROOT/pages/connectors/cassandra.adoc index 6ae0cb477..97f80755c 100644 --- a/documentation/modules/ROOT/pages/connectors/cassandra.adoc +++ b/documentation/modules/ROOT/pages/connectors/cassandra.adoc @@ -911,7 +911,7 @@ Cassandra connector has built-in support for JMX metrics. The Cassandra driver a |The port used by the HTTP server for ping, health check, and build info |[[cassandra-property-cassandra-config]]<> -| +|No default |The absolute path of the YAML config file used by a Cassandra node. |[[cassandra-property-cassandra-hosts]]<> @@ -923,11 +923,11 @@ Cassandra connector has built-in support for JMX metrics. The Cassandra driver a |The port used to connect to Cassandra host(s). |[[cassandra-property-cassandra-username]]<> -| +|No default |The username used when connecting to Cassandra hosts. |[[cassandra-property-cassandra-password]]<> -| +|No default |The password used when connecting to Cassandra hosts. |[[cassandra-property-cassandra-ssl-enabled]]<> @@ -935,7 +935,7 @@ Cassandra connector has built-in support for JMX metrics. The Cassandra driver a |If set to true, Cassandra connector agent will use SSL to connect to Cassandra node. |[[cassandra-property-cassandra-ssl-config-path]]<> -| +|No default |The SSL config file path required for storage node. An example of config file can be found at the bottom of the page. |[[cassandra-property-commit-log-real-time-processing-enabled]]<> @@ -947,7 +947,7 @@ Cassandra connector has built-in support for JMX metrics. The Cassandra driver a |Only applicable in Cassandra 4 and when real-time streaming is enabled by xref:cassandra-property-commit-log-real-time-processing-enabled[`commit.log.real.time.processing.enabled`]. This config determines the frequency at which commit log index file is polled for updates in offset value. |[[cassandra-property-commit-log-relocation-dir]]<> -| +|No default |The local directory where commit logs get relocated to from cdc_raw dir once processed. |[[cassandra-property-commit-log-post-processing-enabled]]<> @@ -991,7 +991,7 @@ For example, + isbn.schema.name: io.debezium.cassandra.type.Isbn |[[cassandra-property-offset-backing-store-dir]]<> -| +|No default |The directory to store offset tracking files. |[[cassandra-property-offset-flush-interval-ms]]<> @@ -1041,7 +1041,7 @@ refreshing the cached Cassandra table schemas. |Whether deletion events should have a subsequent tombstone event (true) or not (false). It's important to note that in Cassandra, two events with the same key may be updating different columns of a given table. So this could potentially result in records being lost during compaction if they have not been consumed by the consumer yet. In other words, do NOT set this to true if you have Kafka compaction turned on. |[[cassandra-property-field-exclude-list]]<> -| +|No default |A comma-separated list of fully-qualified names of fields that should be excluded from change event message values. Fully-qualified names for fields are in the form keyspace_name>... |[[cassandra-property-num-of-change-event-queues]]<> @@ -1054,7 +1054,7 @@ refreshing the cached Cassandra table schemas. See xref:{link-avro-serialization}#avro-naming[Avro naming] for more details. |[[cassandra-property-skipped-operations]]<> -| +|No default | comma-separated list of operation types that will be skipped during streaming. The operations include: `c` for inserts/create, `u` for updates, and `d` for deletes. By default, no operations are skipped. diff --git a/documentation/modules/ROOT/pages/connectors/vitess.adoc b/documentation/modules/ROOT/pages/connectors/vitess.adoc index d585f4f74..27425b087 100644 --- a/documentation/modules/ROOT/pages/connectors/vitess.adoc +++ b/documentation/modules/ROOT/pages/connectors/vitess.adoc @@ -1158,11 +1158,11 @@ The following configuration properties are _required_ unless a default value is |Description |[[vitess-property-name]]<> -| +|No default |Unique name for the connector. Attempting to register again with the same name will fail. This property is required by all Kafka Connect connectors. |[[vitess-property-connector-class]]<> -| +|No default |The name of the Java class for the connector. Always use a value of `io.debezium.connector.vitess.VitessConnector` for the Vitess connector. |[[vitess-property-tasks-max]]<> @@ -1170,7 +1170,7 @@ The following configuration properties are _required_ unless a default value is |The maximum number of tasks that should be created for this connector. The Vitess connector can use more than 1 tasks if you enable offset.storage.per.task mode. |[[vitess-property-database-hostname]]<> -| +|No default |IP address or hostname of the Vitess database server (VTGate). |[[vitess-property-database-port]]<> @@ -1218,7 +1218,7 @@ If set to `true`, you should also consider setting `vitess.gtid` in the configur `RDONLY` represents streaming from the read-only slave MySQL instance. |[[vitess-property-topic-prefix]]<> -| +|No default |Topic prefix that provides a namespace for the particular Vitess database server or cluster in which {prodname} is capturing changes. Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. The prefix should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. @@ -1230,19 +1230,19 @@ If you change the name value, after a restart, instead of continuing to emit eve ==== |[[vitess-property-table-include-list]]<> -| +|No default |An optional, comma-separated list of regular expressions that match fully-qualified table identifiers for tables whose changes you want to capture. Any table not included in `table.include.list` does not have its changes captured. Each identifier is of the form _keyspace_._tableName_. By default, the connector captures changes in every non-system table in each schema whose changes are being captured. Do not also set the `table.exclude.list` property. |[[vitess-property-table-exclude.list]]<> -| +|No default |An optional, comma-separated list of regular expressions that match fully-qualified table identifiers for tables whose changes you *do not* want to capture. Any table not included in `table.exclude.list` has it changes captured. Each identifier is of the form _keyspace_._tableName_. Do not also set the `table.include.list` property. |[[vitess-property-column-include-list]]<> -| +|No default |An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be included in change event record values. Fully-qualified names for columns are of the form _keyspace_._tableName_._columnName_. Do not also set the `column.exclude.list` property. |[[vitess-property-column-exclude-list]]<> -| +|No default |An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form _keyspace_._tableName_._columnName_. Do not also set the `column.include.list` property. |[[vitess-property-tombstones-on-delete]]<> @@ -1370,7 +1370,7 @@ For example, if you set `max.queue.size=1000`, and `max.queue.size.in.bytes=5000 |Indicates whether field names are sanitized to adhere to xref:{link-avro-serialization}#avro-naming[Avro naming requirements]. |[[vitess-property-skipped-operations]]<> -| +|No default | comma-separated list of operation types that will be skipped during streaming. The operations include: `c` for inserts/create, `u` for updates, and `d` for deletes. By default, no operations are skipped. @@ -1384,7 +1384,7 @@ By default, no operations are skipped. |Control the interval between periodic gPRC keepalive pings for VStream. Defaults to `Long.MAX_VALUE` (disabled). |[[vitess-property-grpc-headers]]<> -| +|No default |Specify a comma-separated list of gRPC headers. Defaults to empty. The format is: + + _key1:value1,key2:value2_,... + @@ -1394,7 +1394,7 @@ For example, + `x-envoy-upstream-rq-timeout-ms:0,x-envoy-max-retries:2` |[[vitess-property-grpc-max-inbound-message-size]]<> -| +|No default |Specify the maximum message size in bytes allowed to be received on the channel. + + Default is 4MiB