Open
Conversation
Added info on the STRICT flag
Added info on the STRICT flag to v26.2 documentation. Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed:
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
msbutler
reviewed
Apr 8, 2026
| - {% include {{ page.version.version }}/backups/cap-parameter-ext-connection.md %} | ||
| - {% include {{ page.version.version }}/backups/locality-aware-access.md %} | ||
|
|
||
| Locality-aware backups attempt to match data to buckets in corresponding regions as specified. However, in cases involving unhealthy nodes, a locality-aware backup may be forced to write to a bucket in the default region instead. Use the [`STRICT`]({% link {{ page.version.version }}/backup.md %}#options) option when creating a locality-aware backup to force the backup to fail rather than writing to a bucket in a region that does not match the data being written. |
There was a problem hiding this comment.
- s/ However, in cases involving unhealthy nodes/ However, there are edge cases/r. Then add a separate sentence: For example, if the cluster has unhealthy nodes.
- s/ default region/ default bucker/r
- s/force the backup to fail rather/force the backup to fail to prevent violating data domiciling requirements/r
| `kms` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The URI of the cryptographic key stored in a key management service (KMS), or a comma-separated list of key URIs, used to [take and restore encrypted backups]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples). Refer to [URI Formats]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#uri-formats). The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates and to decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and to list the contents of the backup when using [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}). <br/><br/>AWS KMS, Google Cloud KMS, and Azure Key Vault are supported. | ||
| `incremental_location`<a name="incr-location"></a> | [`STRING`]({% link {{ page.version.version }}/string.md %}) | Create an incremental backup in a different location than the default incremental backup location. <br><br>`WITH incremental_location = 'explicit_incrementals_URI'`<br><br>See [Incremental backups with explicitly specified destinations]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups-with-explicitly-specified-destinations) for usage. No newline at end of file | ||
| `incremental_location`<a name="incr-location"></a> | [`STRING`]({% link {{ page.version.version }}/string.md %}) | Create an incremental backup in a different location than the default incremental backup location. <br><br>`WITH incremental_location = 'explicit_incrementals_URI'`<br><br>See [Incremental backups with explicitly specified destinations]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups-with-explicitly-specified-destinations) for usage. | ||
| `STRICT`<a name="strict"></a> | [`BOOL`]({% link {{ page.version.version }}/bool.md %}) / None | A backup that runs in `STRICT` mode fails if it attempts to back up data from a key-value node with a particular locality tag to a bucket with a different locality tag. No newline at end of file |
There was a problem hiding this comment.
i think this writing here could be clearer. what about: a locality aware backup that runs in STRiCT mode fails if the backup cannot back up data from a node with a locality tag to a bucket with a matching locality tag.
Diagram Anchor Check: FailedFound 6 broken anchor(s) that will cause docs build failures.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: DOC-15775
Adds info on the new
STRICToption as well as a new known limitation onRESTORE.