Skip to content

--enableCheckpointStream replicator flag (#19947) #19955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

--enableCheckpointStream replicator flag (#19947) #19955

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions src/current/_includes/molt/replicator-flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,21 +66,21 @@ The following flags are set with [`--replicator-flags`](#global-flags) and can b

The following flags are set with [`--replicator-flags`](#global-flags) and can be used in [`failback` mode](#fail-back-to-source-database).

| Flag | Type | Description |
|-----------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--assumeIdempotent` | | Disable the extra staging table queries that debounce non-idempotent redelivery in changefeeds. |
| `--bestEffortOnly` | | Eventually-consistent mode; useful for high-throughput, skew-tolerant schemas with [foreign keys]({% link {{ site.current_cloud_version }}/foreign-key.md %}). |
| `--bestEffortWindow` | `DURATION` | Use an eventually-consistent mode for initial backfill or when replication is behind; `0` to disable.<br><br>**Default:** `1h0m0s` |
| `--bindAddr` | `STRING` | The network address to bind to.<br><br>**Default:** `":26258"` |
| `--disableAuthentication` | | Disable authentication of incoming Replicator requests; not recommended for production. |
| `--disableCheckpointStream` | | Disable cross-Replicator checkpoint notifications and rely only on polling. |
| `--discard` | | **Dangerous:** Discard all incoming HTTP requests; useful for changefeed throughput testing. Not intended for production. |
| `--discardDelay` | `DURATION` | Adds additional delay in discard mode; useful for gauging the impact of changefeed round-trip time (RTT). |
| `--healthCheckTimeout` | `DURATION` | The timeout for the health check endpoint.<br><br>**Default:** `5s` |
| `--httpResponseTimeout` | `DURATION` | The maximum amount of time to allow an HTTP handler to execute.<br><br>**Default:** `2m0s` |
| `--immediate` | | Bypass staging tables and write directly to target; recommended only for KV-style workloads with no [foreign keys]({% link {{ site.current_cloud_version }}/foreign-key.md %}). |
| `--limitLookahead` | `INT` | Limit number of checkpoints to be considered when computing the resolving range; may cause replication to stall completely if older mutations cannot be applied. |
| `--ndjsonBufferSize` | `INT` | The maximum amount of data to buffer while reading a single line of `ndjson` input; increase when source cluster has large blob values.<br><br>**Default:** `65536` |
| `--tlsCertificate` | `STRING` | A path to a PEM-encoded TLS certificate chain. |
| `--tlsPrivateKey` | `STRING` | A path to a PEM-encoded TLS private key. |
| `--tlsSelfSigned` | | If true, generate a self-signed TLS certificate valid for `localhost`. |
| Flag | Type | Description |
|----------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--assumeIdempotent` | | Disable the extra staging table queries that debounce non-idempotent redelivery in changefeeds. |
| `--bestEffortOnly` | | Eventually-consistent mode; useful for high-throughput, skew-tolerant schemas with [foreign keys]({% link {{ site.current_cloud_version }}/foreign-key.md %}). |
| `--bestEffortWindow` | `DURATION` | Use an eventually-consistent mode for initial backfill or when replication is behind; `0` to disable.<br><br>**Default:** `1h0m0s` |
| `--bindAddr` | `STRING` | The network address to bind to.<br><br>**Default:** `":26258"` |
| `--disableAuthentication` | | Disable authentication of incoming Replicator requests; not recommended for production. |
| `--enableCheckpointStream` | | Enable checkpoint streaming (use an internal changefeed from the staging table for real-time updates), rather than checkpoint polling (query the staging table for periodic updates), for failback replication. <br><br>**Default:** `false` (use checkpoint polling) |
| `--discard` | | **Dangerous:** Discard all incoming HTTP requests; useful for changefeed throughput testing. Not intended for production. |
| `--discardDelay` | `DURATION` | Adds additional delay in discard mode; useful for gauging the impact of changefeed round-trip time (RTT). |
| `--healthCheckTimeout` | `DURATION` | The timeout for the health check endpoint.<br><br>**Default:** `5s` |
| `--httpResponseTimeout` | `DURATION` | The maximum amount of time to allow an HTTP handler to execute.<br><br>**Default:** `2m0s` |
| `--immediate` | | Bypass staging tables and write directly to target; recommended only for KV-style workloads with no [foreign keys]({% link {{ site.current_cloud_version }}/foreign-key.md %}). |
| `--limitLookahead` | `INT` | Limit number of checkpoints to be considered when computing the resolving range; may cause replication to stall completely if older mutations cannot be applied. |
| `--ndjsonBufferSize` | `INT` | The maximum amount of data to buffer while reading a single line of `ndjson` input; increase when source cluster has large blob values.<br><br>**Default:** `65536` |
| `--tlsCertificate` | `STRING` | A path to a PEM-encoded TLS certificate chain. |
| `--tlsPrivateKey` | `STRING` | A path to a PEM-encoded TLS private key. |
| `--tlsSelfSigned` | | If true, generate a self-signed TLS certificate valid for `localhost`. |
Loading