diff --git a/documentation/antora.yml b/documentation/antora.yml index 6d69fc8cb..43300dcdf 100644 --- a/documentation/antora.yml +++ b/documentation/antora.yml @@ -25,6 +25,7 @@ asciidoc: community: true registry: 'Apicurio Registry' registry-name-full: Apicurio API and Schema Registry + snippetsdir: /snippets link-avro-serialization: 'configuration/avro.adoc' link-cassandra-connector: 'connectors/cassandra.adoc' link-cloud-events: 'integrations/cloudevents.adoc' diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/proc-running-an-ad-hoc-snapshot-with-additional-conditions.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/proc-running-an-ad-hoc-snapshot-with-additional-conditions.adoc index 43671dc15..5b621b5d6 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/proc-running-an-ad-hoc-snapshot-with-additional-conditions.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/proc-running-an-ad-hoc-snapshot-with-additional-conditions.adoc @@ -28,12 +28,12 @@ For example, suppose you have a `products` {data-collection} that contains the f If you want an incremental snapshot of the `products` {data-collection} to include only the data items where `color=blue`, you can use the following SQL statement to trigger the snapshot: -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=snapshot-additional-conditions-example] +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=snapshot-additional-conditions-example] The `additional-conditions` parameter also enables you to pass conditions that are based on more than one column. For example, using the `products` {data-collection} from the previous example, you can submit a query that triggers an incremental snapshot that includes the data of only those items for which `color=blue` and `quantity>10`: -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=snapshot-multiple-additional-conditions-example] +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=snapshot-multiple-additional-conditions-example] The following example, shows the JSON for an incremental snapshot event that is captured by a connector. diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-kafka.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-kafka.adoc index bbd2126e0..89b296489 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-kafka.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-kafka.adoc @@ -25,4 +25,4 @@ Specify {data-collection} names by using the format `{collection-container}.{dat |=== The following example shows a typical `stop-snapshot` Kafka message: -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=stopping-incremental-snapshot-kafka-example] +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=stopping-incremental-snapshot-kafka-example] diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-sql.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-sql.adoc index e2c9f0819..31d094891 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-sql.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/proc-stopping-an-incremental-snapshot-sql.adoc @@ -26,7 +26,7 @@ INSERT INTO __ (id, type, data) values (_''_, 'stop-snapshot', + For example, + -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=stopping-incremental-snapshot-example] +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=stopping-incremental-snapshot-example] + The values of the `id`, `type`, and `data` parameters in the signal command correspond to the {link-prefix}:{link-signalling}#debezium-signaling-description-of-required-structure-of-a-signaling-data-collection[fields of the signaling {data-collection}]. + diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-kafka.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-kafka.adoc index 40f244809..82f7765f1 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-kafka.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-kafka.adoc @@ -56,10 +56,8 @@ When the snapshot request includes an `additional-conditions` property, the `dat `SELECT * FROM __ WHERE __ ....` For example, given a `products` {data-collection} with the columns `id` (primary key), `color`, and `brand`, if you want a snapshot to include only content for which `color='blue'`, when you request the snapshot, you could add the `additional-conditions` property to filter the content: - -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=triggering-incremental-snapshot-kafka-addtl-cond-example] +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=triggering-incremental-snapshot-kafka-addtl-cond-example] You can also use the `additional-conditions` property to pass conditions based on multiple columns. For example, using the same `products` {data-collection} as in the previous example, if you want a snapshot to include only the content from the `products` {data-collection} for which `color='blue'`, and `brand='MyBrand'`, you could send the following request: - -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=triggering-incremental-snapshot-kafka-multi-addtl-cond-example] +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=triggering-incremental-snapshot-kafka-multi-addtl-cond-example] diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-sql.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-sql.adoc index af2ac2c9c..80b58e742 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-sql.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot-sql.adoc @@ -13,8 +13,7 @@ To specify the {data-collection}s to include in the snapshot, provide a `data-co The `data-collections` array for an incremental snapshot signal has no default value. If the `data-collections` array is empty, {prodname} interprets the empty array to mean that no action is required, and it does not perform a snapshot. -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=fq-table-name-format-note] - +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=fq-table-name-format-note] .Prerequisites * {link-prefix}:{link-signalling}#debezium-signaling-enabling-source-signaling-channel[Signaling is enabled]. + @@ -32,7 +31,7 @@ INSERT INTO __ (id, type, data) VALUES (_''_, _'' + For example, + -include::{partialsdir}/modules/snippets/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=snapshot-signal-example] +include::{snippetsdir}/{context}-frag-signaling-fq-table-formats.adoc[leveloffset=+1,tags=snapshot-signal-example] + The values of the `id`,`type`, and `data` parameters in the command correspond to the {link-prefix}:{link-signalling}#debezium-signaling-description-of-required-structure-of-a-signaling-data-collection[fields of the signaling {data-collection}]. +