Skip to content

Commit 4381f79

Browse files
committed
docs: clean up 4.99.0 connector docs after review
Fixes a few things the review turned up in the generated 4.99.0 docs: - Use US spelling (behavior, not behaviour) in the new snapshot_mode, row_operation, and global_table descriptions. - Drop em dashes from the row_operation and global_table descriptions. - Point the deprecated stream_snapshot entry in what's-new at the snapshot_mode anchor instead of a #stream_snapshot anchor that no longer exists, and tell people to use snapshot_mode. - Update the Oracle CDC intro so it stops pointing at the deprecated stream_snapshot field. Also added overrides for snapshot_mode, row_operation, and global_table so these descriptions survive the next regeneration.
1 parent 2bb4884 commit 4381f79

6 files changed

Lines changed: 21 additions & 9 deletions

File tree

docs-data/overrides.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,10 @@
415415
{
416416
"name": "table_discovery_mode",
417417
"description": "`single`: Streams from tables specified in the `tables` list. `tag`: Auto-discovers tables by tags (ignores the `tables` field). `includelist`: Streams from tables in the `tables` list. Use `single` instead; `includelist` is kept for backward compatibility."
418+
},
419+
{
420+
"name": "global_table",
421+
"description": "Provision the checkpoint table as a DynamoDB Global Table (v2) so checkpoints replicate across regions. Requires `global_table_replicas`. When the table is auto-created it is created as a global table; when it already exists, its replicas are reconciled (missing regions are added via `UpdateTable`). The existing table must have been created in global mode (`TableId` hash key). Enabling this against a pre-existing non-global checkpoint table fails fast with a clear error."
418422
}
419423
]
420424
}
@@ -1608,6 +1612,10 @@
16081612
"name": "wallet_password",
16091613
"type": "string",
16101614
"description": "Password for the `ewallet.p12` PKCS#12 wallet file. Only use this when the wallet directory contains `ewallet.p12` rather than `cwallet.sso`.\n\ninclude::connect:components:partial$secret_warning.adoc[]"
1615+
},
1616+
{
1617+
"name": "snapshot_mode",
1618+
"description": "Controls snapshot behavior. `none` (default) skips snapshotting and starts streaming from the current SCN. `snapshot_only` performs a full snapshot, persists the SCN checkpoint, then stops without streaming. `snapshot_and_stream` performs a full snapshot then transitions to streaming."
16111619
}
16121620
]
16131621
}
@@ -3992,6 +4000,10 @@
39924000
"name": "table",
39934001
"description": "The destination Iceberg table name. This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions]."
39944002
},
4003+
{
4004+
"name": "row_operation",
4005+
"description": "The row-level operation to apply for each message: `insert` (append), `upsert` (replace rows matching `identifier_fields`, then append), or `delete` (remove rows matching `identifier_fields`). Supports interpolation so the operation can be driven by the data, such as a change-data-capture stream's operation field. Defaults to `insert`, preserving the original append-only behavior.\n\nSee the <<row-level-operations,Row-level operations>> section above for the full semantics, the format-version-2 upgrade, batching behavior, and important caveats."
4006+
},
39954007
{
39964008
"name": "catalog",
39974009
"children": [

modules/components/pages/inputs/oracledb_cdc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Introduced in version 4.83.0.
1515
endif::[]
1616

1717
Streams changes from an Oracle database for Change Data Capture (CDC).
18-
Additionally, if `stream_snapshot` is set to true, existing data in the database is also streamed.
18+
Use the `snapshot_mode` field to control whether existing data is captured in an initial snapshot before streaming changes.
1919

2020
[tabs]
2121
======

modules/components/partials/fields/inputs/aws_dynamodb_cdc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Allows you to specify a custom endpoint for the AWS API.
8888

8989
=== `global_table`
9090

91-
Provision the checkpoint table as a DynamoDB Global Table (v2) so checkpoints replicate across regions. Requires `global_table_replicas`. When the table is auto-created it is created as a global table; when it already exists, its replicas are reconciled (missing regions are added via `UpdateTable`). The existing table must have been created in global mode (`TableId` hash key) — enabling this against a pre-existing non-global checkpoint table fails fast with a clear error.
91+
Provision the checkpoint table as a DynamoDB Global Table (v2) so checkpoints replicate across regions. Requires `global_table_replicas`. When the table is auto-created it is created as a global table; when it already exists, its replicas are reconciled (missing regions are added via `UpdateTable`). The existing table must have been created in global mode (`TableId` hash key). Enabling this against a pre-existing non-global checkpoint table fails fast with a clear error.
9292

9393
*Type*: `bool`
9494

modules/components/partials/fields/inputs/oracledb_cdc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ The maximum number of rows to be streamed in a single batch when taking a snapsh
328328

329329
=== `snapshot_mode`
330330

331-
Controls snapshot behaviour. `none` (default) skips snapshotting and starts streaming from the current SCN. `snapshot_only` performs a full snapshot, persists the SCN checkpoint, then stops without streaming. `snapshot_and_stream` performs a full snapshot then transitions to streaming.
331+
Controls snapshot behavior. `none` (default) skips snapshotting and starts streaming from the current SCN. `snapshot_only` performs a full snapshot, persists the SCN checkpoint, then stops without streaming. `snapshot_and_stream` performs a full snapshot then transitions to streaming.
332332

333333
ifndef::env-cloud[]
334334
Requires version 4.99.0 or later.

modules/components/partials/fields/outputs/iceberg.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -454,9 +454,9 @@ The encoding to use for string and binary columns. Use `plain` for compatibility
454454

455455
=== `row_operation`
456456

457-
The row-level operation to apply for each message: `insert` (append), `upsert` (replace rows matching `identifier_fields`, then append), or `delete` (remove rows matching `identifier_fields`). Supports interpolation so the operation can be driven by the data — e.g. a change-data-capture stream's operation field. Defaults to `insert`, preserving the original append-only behaviour.
457+
The row-level operation to apply for each message: `insert` (append), `upsert` (replace rows matching `identifier_fields`, then append), or `delete` (remove rows matching `identifier_fields`). Supports interpolation so the operation can be driven by the data, such as a change-data-capture stream's operation field. Defaults to `insert`, preserving the original append-only behavior.
458458

459-
See the <<row-level-operations,Row-level operations>> section above for the full semantics, the format-version-2 upgrade, batching behaviour, and important caveats.
459+
See the <<row-level-operations,Row-level operations>> section above for the full semantics, the format-version-2 upgrade, batching behavior, and important caveats.
460460

461461
This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions].
462462

modules/get-started/pages/whats-new.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ This release adds support for the following new fields:
3636

3737

3838
|snapshot_mode
39-
|Controls snapshot behaviour.
39+
|Controls snapshot behavior.
4040
|*Inputs:*
4141

4242
* xref:components:inputs/oracledb_cdc.adoc#snapshot_mode[oracledb_cdc]
4343

4444

4545
|row_operation
46-
|The row-level operation to apply for each message: `insert` (append), `upsert` (replace rows matching `identifier_fields`, then append), or `delete` (remove rows matching `identifier_fields`). Supports interpolation so the operation can be driven by the data — e.g. a change-data-capture stream's operation field.
46+
|The row-level operation to apply for each message: `insert` (append), `upsert` (replace rows matching `identifier_fields`, then append), or `delete` (remove rows matching `identifier_fields`). Supports interpolation so the operation can be driven by the data, such as a change-data-capture stream's operation field.
4747
|*Outputs:*
4848

4949
* xref:components:outputs/iceberg.adoc#row_operation[iceberg]
@@ -68,10 +68,10 @@ The following fields are now deprecated:
6868
|Field |Description |Affected components
6969

7070
|stream_snapshot
71-
|If set to true, the connector will query all the existing data as a part of snapshot process. Otherwise, it will start from the current System Change Number position.
71+
|Controls whether the connector snapshots existing data before streaming changes. Use `snapshot_mode` instead.
7272
|*Inputs:*
7373

74-
* xref:components:inputs/oracledb_cdc.adoc#stream_snapshot[oracledb_cdc]
74+
* xref:components:inputs/oracledb_cdc.adoc#snapshot_mode[oracledb_cdc]
7575

7676

7777
|===

0 commit comments

Comments
 (0)