alexey.rassokhin/tet123
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

DBZ-6023 [doc] Documentation for surrogate-key field from execute-snapshot signal record.

Browse Source
This commit is contained in:
PlugaruT 2023-03-09 19:30:53 +02:00 committed by roldanbob
parent 405be98721
commit 5d1bb1aa80
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/modules/ROOT/partials/modules/all-connectors/con-connector-ad-hoc-snapshots.adoc
View File

@ -50,6 +50,12 @@ ifeval::['{context}' != 'mongodb']
subset of the contents of the {data-collection}(s).
endif::[]
ifeval::['{context}' != 'mongodb']
|`surrogate-key`
|_N/A_
| An optional string, which represents a column name that will be used during the snapshot process as a primary key of the {data-collection}(s).
endif::[]
|===
.Triggering an ad hoc snapshot

5
documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot.adoc
View File

@ -48,7 +48,7 @@ tag::sql-based-snapshot[]
+
[source,sql,indent=0,subs="+attributes,+quotes"]
----
INSERT INTO _<signalTable>_ (id, type, data) VALUES (_'<id>'_, _'<snapshotType>'_, '{"data-collections": ["_<tableName>_","_<tableName>_"],"type":"_<snapshotType>_","additional-condition":"_<additional-condition>_"}');
INSERT INTO _<signalTable>_ (id, type, data) VALUES (_'<id>'_, _'<snapshotType>'_, '{"data-collections": ["_<tableName>_","_<tableName>_"],"type":"_<snapshotType>_","additional-condition":"_<additional-condition>_","surrogate-key":"_<surrogate-key>_"}');
----
+
For example,
@ -128,6 +128,9 @@ If you do not specify a value, the connector runs an incremental snapshot.
| An optional string, which specifies a condition based on the column(s) of the {data-collection}(s), to capture a
subset of the contents of the {data-collection}s.
For more information about the `additional-condition` parameter, see xref:{context}-incremental-snapshots-additional-condition[].
|7
|`surrogate-key`
|An optional string, which specifies a column name to use as the primary key for the snapshot. This allows to override the default primary key of the table.
|===
[id="{context}-incremental-snapshots-additional-condition"]