COCKROACH-DEBUG-CHECK-STORE(1)

NAME

cockroach-debug-check-store - consistency check for a single store

SYNOPSIS

cockroach debug check-store [flags]

DESCRIPTION

Perform local consistency checks of a single store.

Capable of detecting the following errors: * Raft logs that are inconsistent with their metadata * MVCC stats that are inconsistent with the data within the range

OPTIONS

--enterprise-encryption=

Specify encryption options for one of the stores on a node. If multiple
 stores exist, the flag must be specified for each store.

A valid enterprise license is required to use this functionality.

Key files should be generated by "cockroach gen encryption-key".

Valid fields:

    •   path (required): must match the path of one of the stores, or the special
                           value "*" to match all stores

    •   key (required): path to the current key file, or "plain"

    •   old-key (required): path to the previous key file, or "plain"

    •   rotation-period : amount of time after which data keys should be rotated

example:
   --enterprise-encryption=path=cockroach-data,key=/keys/aes-128.key,old-key=plain

-h, --help[=false]
    help for check-store

OPTIONS INHERITED FROM PARENT COMMANDS

--enterprise-require-fips-ready[=false]
    abort if FIPS readiness checks fail

--log=

Logging configuration, expressed using YAML syntax. For example, you can
 change the default logging directory with: --log='file-defaults: {dir: ...}'.
 See the documentation for more options and details. To preview how the log
 configuration is applied, or preview the default configuration, you can use
 the 'cockroach debug check-log-config' sub-command.

--log-config-file=

File name to read the logging configuration from. This has the same effect as
 passing the content of the file via the --log flag.

--log-config-vars=[]

Environment variables that will be expanded if present in the body of the
 logging configuration.

--log-dir=

--log-dir=XXX is an alias for --log='file-defaults: {dir: XXX}'.

--logtostderr[=UNKNOWN]

--logtostderr=XXX is an alias for --log='sinks: {stderr: {filter: XXX}}'. If
 no value is specified, the default value for the command is inferred: INFO for
 server commands, WARNING for client commands.

--redactable-logs=false

--redactable-logs=XXX is an alias for --log='file-defaults: {redactable:
 XXX}}'.

--vmodule=
    comma-separated list of pattern=N settings for file-filtered logging (significantly hurts performance)

SEE ALSO

cockroach-debug(1)

HISTORY

13-May-2026 Auto generated by spf13/cobra