diff --git a/documentation/modules/ROOT/pages/configuration/signalling.adoc b/documentation/modules/ROOT/pages/configuration/signalling.adoc index 547b2eece..6334fb520 100644 --- a/documentation/modules/ROOT/pages/configuration/signalling.adoc +++ b/documentation/modules/ROOT/pages/configuration/signalling.adoc @@ -210,7 +210,7 @@ This property is deprecated and should be replaced by additional-conditions. |`additional-conditions` |_N/A_ -| An optional array of additional condition that specifies a condition that the connector evaluates to designate a subset of records to include in a snapshot. + +| An optional array that specifies a set of additional conditions that the connector evaluates to determine the subset of records to include in a snapshot. + Each additional condition is an object with `data-collection` and `filter` properties. You can now specify different filters for different data collection. * The `data-collection` property is the fully-qualified name of the data collection for which the filter will be applied. @@ -273,7 +273,7 @@ This property is deprecated and should be replaced by additional-conditions. |`additional-conditions` |_N/A_ -| An optional array of additional condition that specifies a condition that the connector evaluates to designate a subset of records to include in a snapshot. + +|An optional array that specifies a set of additional conditions that the connector evaluates to determine the subset of records to include in a snapshot. + Each additional condition is an object with `data-collection` and `filter` properties. You can now specify different filters for different data collection. * The `data-collection` property is the fully-qualified name of the data collection for which the filter will be applied. diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-ad-hoc-snapshots.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-ad-hoc-snapshots.adoc index 650236a16..aabc964dd 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-ad-hoc-snapshots.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-ad-hoc-snapshots.adoc @@ -51,12 +51,13 @@ subset of the contents of the {data-collection}(s). + [NOTE] ==== -This property is deprecated and should be replaced by additional-conditions. +This property is deprecated. +To specify criteria for defining the subset of data that you want the snapshot to capture, use the `additional-conditions` parameter. ==== |`additional-conditions` |_N/A_ -| An optional array of additional condition that specifies a condition that the connector evaluates to designate a subset of records to include in a snapshot. + +|An optional array that specifies a set of additional conditions that the connector evaluates to determine the subset of records to include in a snapshot. + Each additional condition is an object with `data-collection` and `filter` properties. You can now specify different filters for different data collection. * The `data-collection` property is the fully-qualified name of the data collection for which the filter will be applied. diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-blocking-snapshot.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-blocking-snapshot.adoc index e0791a029..a3849842d 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-blocking-snapshot.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/con-connector-blocking-snapshot.adoc @@ -14,13 +14,13 @@ After the snapshot completes, the streaming is resumed. .Configure snapshot -In the `data` section of the signal you can use the following properties: +You can set the following properties in the `data` component of a signal: * data-collections: to specify which {data-collection}s must be snapshot * additional-conditions: You can specify different filters for different {data-collection}. + * The `data-collection` property is the fully-qualified name of the {data-collection} for which the filter will be applied. * The `filter` property will have the same value used in the `snapshot.select.statement.overrides` -Fo example +For example: [source,json] ---- {"type": "blocking", "data-collections": ["schema1.table1", "schema1.table2"], "additional-conditions": [{"data-collection": "schema1.table1", "filter": "SELECT * FROM [schema1].[table1] WHERE column1 = 0 ORDER BY column2 DESC"}, {"data-collection": "schema1.table2", "filter": "SELECT * FROM [schema1].[table2] WHERE column2 > 0"}]} 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 7f3531b10..1ce457a71 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 @@ -30,12 +30,12 @@ Specify the names by using the same format as is required for the xref:{context} [NOTE] ==== -This property is deprecated and should be replaced by additional-conditions. +This property is deprecated and should be replaced by the `additional-conditions` property. ==== |`additional-conditions` |_N/A_ -| An optional array of additional condition that specifies a condition that the connector evaluates to designate a subset of records to include in a snapshot. + +| An optional array of additional conditions that specifies criteria that the connector evaluates to designate a subset of records to include in a snapshot. + Each additional condition is an object with `data-collection` and `filter` properties. You can now specify different filters for different data collection. * The `data-collection` property is the fully-qualified name of the data collection for which the filter will be applied. @@ -58,7 +58,7 @@ Typically, when {prodname} runs a snapshot, it runs a SQL query such as: `SELECT * FROM __ ....` -When the snapshot request includes an `additional-conditions`, the `data-collection` and `filter` property of the `additional-conditions` is appended to the SQL query, for example: +When the snapshot request includes an `additional-conditions` property, the `data-collection` and `filter` parameters of the property are appended to the SQL query, for example: `SELECT * FROM __ WHERE __ ....` 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 909400551..0782030c7 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 @@ -85,8 +85,9 @@ If you do not specify a value, the connector runs an incremental snapshot. |6 |`additional-conditions` -| An optional array of additional condition that specifies a condition that the connector evaluates to designate a subset of records to include in a snapshot. + -Each additional condition is an object with `data-collection` and `filter` properties. You can now specify different filters for different data collection. + +| An optional array that specifies a set of additional conditions that the connector evaluates to determine the subset of records to include in a snapshot. + +Each additional condition is an object with `data-collection` and `filter` properties. +You can specify different filters for each data collection. + * The `data-collection` property is the fully-qualified name of the data collection for which the filter will be applied. For more information about the `additional-conditions` parameter, see xref:{context}-incremental-snapshots-additional-conditions[]. |=== diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot.adoc index e4e5f5217..ac3dc1e87 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/proc-triggering-an-incremental-snapshot.adoc @@ -126,8 +126,8 @@ If you do not specify a value, the connector runs an incremental snapshot. |6 |`additional-conditions` -| An optional array of additional condition that specifies a condition that the connector evaluates to designate a subset of records to include in a snapshot. + -Each additional condition is an object with `data-collection` and `filter` properties. You can now specify different filters for different data collection. + +| An optional array that specifies a set of additional conditions that the connector evaluates to determine the subset of records to include in a snapshot. + +Each additional condition is an object with `data-collection` and `filter` properties. You can specify different filters for each data collection. + * The `data-collection` property is the fully-qualified name of the data collection for which the filter will be applied. For more information about the `additional-conditions` parameter, see xref:{context}-incremental-snapshots-additional-conditions[]. |7