DBZ-8090 Place connector-specific table-naming examples in shared files

This commit is contained in:
roldanbob 2024-08-14 10:35:09 -04:00
parent 2644ba617a
commit 6c93c64784
7 changed files with 157 additions and 0 deletions

View File

@ -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[]

View File

@ -0,0 +1 @@
include::../{partialsdir}/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc[]

View File

@ -0,0 +1 @@
include::../{partialsdir}/modules/snippets/mysql-frag-signaling-fq-table-formats.adoc[]

View File

@ -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[]

View File

@ -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[]

View File

@ -0,0 +1 @@
include::../{partialsdir}/modules/snippets/db2-frag-signaling-fq-table-formats.adoc[]

View File

@ -0,0 +1 @@
include::../{partialsdir}/modules/snippets/oracle-frag-signaling-fq-table-formats.adoc[]