From 6c93c64784374433f4149a180869503ed28a9a51 Mon Sep 17 00:00:00 2001 From: roldanbob Date: Wed, 14 Aug 2024 10:35:09 -0400 Subject: [PATCH] DBZ-8090 Place connector-specific table-naming examples in shared files --- .../db2-frag-signaling-fq-table-formats.adoc | 61 +++++++++++++++++++ ...ormix-frag-signaling-fq-table-formats.adoc | 1 + ...riadb-frag-signaling-fq-table-formats.adoc | 1 + ...mysql-frag-signaling-fq-table-formats.adoc | 39 ++++++++++++ ...racle-frag-signaling-fq-table-formats.adoc | 53 ++++++++++++++++ ...resql-frag-signaling-fq-table-formats.adoc | 1 + ...erver-frag-signaling-fq-table-formats.adoc | 1 + 7 files changed, 157 insertions(+) create mode 100644 documentation/modules/ROOT/partials/modules/snippets/db2-frag-signaling-fq-table-formats.adoc create mode 100644 documentation/modules/ROOT/partials/modules/snippets/informix-frag-signaling-fq-table-formats.adoc create mode 100644 documentation/modules/ROOT/partials/modules/snippets/mariadb-frag-signaling-fq-table-formats.adoc create mode 100644 documentation/modules/ROOT/partials/modules/snippets/mysql-frag-signaling-fq-table-formats.adoc create mode 100644 documentation/modules/ROOT/partials/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc create mode 100644 documentation/modules/ROOT/partials/modules/snippets/postgresql-frag-signaling-fq-table-formats.adoc create mode 100644 documentation/modules/ROOT/partials/modules/snippets/sqlserver-frag-signaling-fq-table-formats.adoc diff --git a/documentation/modules/ROOT/partials/modules/snippets/db2-frag-signaling-fq-table-formats.adoc b/documentation/modules/ROOT/partials/modules/snippets/db2-frag-signaling-fq-table-formats.adoc new file mode 100644 index 000000000..5d734dc99 --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/snippets/db2-frag-signaling-fq-table-formats.adoc @@ -0,0 +1,61 @@ +tag::fq-table-format-in-example[] +For example, to include a table that exists in the `*public*` schema and that has the name `*My.Table*`, use the following format: `*"public"."My.Table"*`. +end::fq-table-format-in-example[] + + +tag::snapshot-signal-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO myschema.debezium_signal (id, type, data) // <1> +values ('ad-hoc-1', // <2> + 'execute-snapshot', // <3> + '{"data-collections": ["schema1.table1", "schema2.table2"], // <4> + "type":"incremental", // <5> + "additional-conditions":[{"data-collection": "schema1.table1" ,"filter":"color=\'blue\'"}]}'); // <6> +---- +end::snapshot-signal-example[] + + +tag::snapshot-additional-conditions-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["schema1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "schema1.products", "filter": "color=blue"}]}'); +---- +end::snapshot-additional-conditions-example[] + + +tag::snapshot-multiple-additional-conditions-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["schema1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "schema1.products", "filter": "color=blue AND quantity>10"}]}'); +---- +end::snapshot-multiple-additional-conditions-example[] + + +tag::triggering-incremental-snapshot-kafka-addtl-cond-example[] +---- +Key = `test_connector` + +Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.products"], "type": "INCREMENTAL", "additional-conditions": [{"data-collection": "schema1.products" ,"filter":"color='blue'"}]}}` +---- +end::triggering-incremental-snapshot-addtl-cond-kafka-example[] + + +tag::triggering-incremental-snapshot-kafka-multi-addtl-cond-example[] +---- +Key = `test_connector` + +Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.products"], "type": "INCREMENTAL", "additional-conditions": [{"data-collection": "schema1.products" ,"filter":"color='blue' AND brand='MyBrand'"}]}}` +---- +end::triggering-incremental-snapshot-kafka-multi-addtl-cond-example[] + +tag::stopping-incremental-snapshot-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO myschema.debezium_signal (id, type, data) // <1> +values ('ad-hoc-1', // <2> + 'stop-snapshot', // <3> + '{"data-collections": ["schema1.table1", "schema2.table2"], // <4> + "type":"incremental"}'); // <5> +---- +end::stopping-incremental-snapshot-example[] diff --git a/documentation/modules/ROOT/partials/modules/snippets/informix-frag-signaling-fq-table-formats.adoc b/documentation/modules/ROOT/partials/modules/snippets/informix-frag-signaling-fq-table-formats.adoc new file mode 100644 index 000000000..39d92ecc7 --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/snippets/informix-frag-signaling-fq-table-formats.adoc @@ -0,0 +1 @@ +include::../{partialsdir}/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc[] diff --git a/documentation/modules/ROOT/partials/modules/snippets/mariadb-frag-signaling-fq-table-formats.adoc b/documentation/modules/ROOT/partials/modules/snippets/mariadb-frag-signaling-fq-table-formats.adoc new file mode 100644 index 000000000..e0aa2363a --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/snippets/mariadb-frag-signaling-fq-table-formats.adoc @@ -0,0 +1 @@ +include::../{partialsdir}/modules/snippets/mysql-frag-signaling-fq-table-formats.adoc[] diff --git a/documentation/modules/ROOT/partials/modules/snippets/mysql-frag-signaling-fq-table-formats.adoc b/documentation/modules/ROOT/partials/modules/snippets/mysql-frag-signaling-fq-table-formats.adoc new file mode 100644 index 000000000..6143b2e34 --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/snippets/mysql-frag-signaling-fq-table-formats.adoc @@ -0,0 +1,39 @@ +tag::fq-table-format-in-example[] +For example, to include a table that exists in the `*db1*` database and that has the name `*My.Table*`, use the following format: `*"db1"."My.Table"*`. +end::fq-table-format-in-example[] + +tag::snapshot-signal-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO db1.debezium_signal (id, type, data) // <1> +values ('ad-hoc-1', // <2> + 'execute-snapshot', // <3> + '{"data-collections": ["db1.table1", "db1.table2"], // <4> + "type":"incremental", // <5> + "additional-conditions":[{"data-collection": "db1.table1" ,"filter":"color=\'blue\'"}]}'); // <6> +---- +end::snapshot-signal-example[] + +tag::snapshot-additional-conditions-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO db1.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["db1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "db1.products", "filter": "color=blue"}]}'); +---- +end::snapshot-additional-conditions-example[] + + +tag::triggering-incremental-snapshot-kafka-addtl-cond-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO db1.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["db1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "db1.products", "filter": "color=blue AND quantity>10"}]}'); +---- +end::triggering-incremental-snapshot-kafka-addtl-cond-example[] + + +tag::triggering-incremental-snapshot-kafka-multi-addtl-cond-example[] +---- +Key = `test_connector` + +Value = `{"type":"execute-snapshot","data": {"data-collections": ["db1.products"], "type": "INCREMENTAL", "additional-conditions": [{"data-collection": "db1.products" ,"filter":"color='blue' AND brand='MyBrand'"}]}}` +---- +end::triggering-incremental-snapshot-kafka-multi-addtl-cond-example[] diff --git a/documentation/modules/ROOT/partials/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc b/documentation/modules/ROOT/partials/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc new file mode 100644 index 000000000..4abfeeff3 --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc @@ -0,0 +1,53 @@ +tag::fq-table-format-in-example[] +For example, to include a table that exists in the `*db1*` database in the `*public*` schema, and that has the name `*My.Table*`, use the following format: `*"db1"."public"."My.Table"*`. +end::fq-table-format-in-example[] + + + +tag::snapshot-signal-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO db1.myschema.debezium_signal (id, type, data) // <1> +values ('ad-hoc-1', // <2> + 'execute-snapshot', // <3> + '{"data-collections": ["db1.schema1.table1", "db1.schema2.table2"], // <4> + "type":"incremental", // <5> + "additional-conditions":[{"data-collection": "db1.schema1.table1" ,"filter":"color=\'blue\'"}]}'); // <6> +---- +end::snapshot-signal-example[] + + + +tag::snapshot-additional-conditions-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO db1.myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["db1.schema1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "db1.schema1.products", "filter": "color=blue"}]}'); +---- +end::snapshot-additional-conditions-example[] + + +tag::snapshot-multiple-additional-conditions-example[] +[source,sql,indent=0,subs="+attributes"] +---- +INSERT INTO db1.myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["db1.schema1.products"],"type":"incremental", "additional-conditions":[{"data-collection": "db1.schema1.products", "filter": "color=blue AND quantity>10"}]}'); +---- +end::snapshot-multiple-additional-conditions-example[] + + + +tag::triggering-incremental-snapshot-kafka-addtl-cond-example[] +---- +Key = `test_connector` + +Value = `{"type":"execute-snapshot","data": {"data-collections": ["db1.schema1.products"], "type": "INCREMENTAL", "additional-conditions": [{"data-collection": "db1.schema1.products" ,"filter":"color='blue'"}]}}` +---- +end::triggering-incremental-snapshot-kafka-addtl-cond-example[] + + +tag::triggering-incremental-snapshot-kafka-multi-addtl-cond-example[] +---- +Key = `test_connector` + +Value = `{"type":"execute-snapshot","data": {"data-collections": ["db1.schema1.products"], "type": "INCREMENTAL", "additional-conditions": [{"data-collection": "db1.schema1.products" ,"filter":"color='blue' AND brand='MyBrand'"}]}}` +---- +end::triggering-incremental-snapshot-kafka-multi-addtl-cond-example[] diff --git a/documentation/modules/ROOT/partials/modules/snippets/postgresql-frag-signaling-fq-table-formats.adoc b/documentation/modules/ROOT/partials/modules/snippets/postgresql-frag-signaling-fq-table-formats.adoc new file mode 100644 index 000000000..9e784ee41 --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/snippets/postgresql-frag-signaling-fq-table-formats.adoc @@ -0,0 +1 @@ +include::../{partialsdir}/modules/snippets/db2-frag-signaling-fq-table-formats.adoc[] diff --git a/documentation/modules/ROOT/partials/modules/snippets/sqlserver-frag-signaling-fq-table-formats.adoc b/documentation/modules/ROOT/partials/modules/snippets/sqlserver-frag-signaling-fq-table-formats.adoc new file mode 100644 index 000000000..39d92ecc7 --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/snippets/sqlserver-frag-signaling-fq-table-formats.adoc @@ -0,0 +1 @@ +include::../{partialsdir}/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc[]