COCKROACH-DEBUG-STATEMENT-BUNDLE-RECREATE(1)

NAME

cockroach-debug-statement-bundle-recreate - recreate the statement bundle in a demo cluster

SYNOPSIS

cockroach debug statement-bundle recreate [flags]

DESCRIPTION

Run the recreate tool to populate a demo cluster with the environment, schema, and stats in an unzipped statement bundle directory.

OPTIONS

--auto-enable-rangefeeds[=true]

If set to false, overrides the default demo behavior of enabling rangefeeds.

--cache=64 MiB

Total size in bytes for caches per node, shared evenly if there are multiple
 storage devices. Size suffixes are supported (e.g. 1GB and 1GiB). If left
 unspecified, defaults to 64MiB. A percentage of physical memory can also be
 specified (e.g. .25).

--debug-sql-cli[=false]

Simplify the SQL CLI to ease troubleshooting of CockroachDB issues. This
 echoes sent SQL, removes the database name and txn status from the prompt, and
 forces behavior to become independent on current transaction state. Equivalent
 to --echo-sql, \unset check_syntax and \set prompt1 %n@%M>.

--demo-locality=

Locality information for each demo node. The input is a colon separated list
 of localities for each node. The i'th locality in the colon separated list
 sets the locality for the i'th demo cockroach node. For example:

--demo-locality=region=us-east1,az=1:region=us-east1,az=2:region=us-east1,az=3

Assigns node1's region to us-east1 and availability zone to 1, node 2's region
 to us-east1 and availability zone to 2, and node 3's region to us-east1 and
 availability zone to 3.

--disable-demo-license[=false]

If set, disable enterprise features.

--echo-sql[=false]

Reveal the SQL statements sent implicitly by the command-line utility.

--embedded[=false]

Simplify and reduce the SQL CLI output to make it appropriate for embedding in
 a 'playground'-type environment. This causes the shell to omit informational
 message about aspects that can only be changed with command-line flags or
 environment variables: in an embedded environment, the user has no control
 over these and the messages would thus be confusing. It also causes the shell
 to omit informational messages about networking details (e.g. server address),
 as it is assumed that the embedding environment will report those instead.

-e, --execute=

Execute the SQL statement(s) on the command line, then exit. This flag may
 be specified multiple times and each value may contain multiple semicolon
 separated statements. If an error occurs in any statement, the command exits
 with a non-zero status code and further statements are not executed. The
 results of each SQL statement are printed on the standard output. This flag
 is incompatible with --file / -f.

--expand-schema=0

Expand the workload schema up to the specified size.

--explain-cmd="EXPLAIN"
    set the EXPLAIN command used to produce the final output when displaying all optimal explain plans with --placeholder. Example: EXPLAIN(OPT)

-f, --file=""

Read and execute the SQL statement(s) from the specified file. The file is
 processed as if it has been redirected on the standard input of the shell.
 This flag is incompatible with --execute / -e.

--format="table"

Selects how to display table rows in results. Possible values: tsv, csv,
 table, records, ndjson, json, sql, html, raw. If left unspecified, defaults to
 tsv for non-interactive sessions and table for interactive sessions.

--geo-partitioned-replicas[=false]

When used with the Movr dataset, create a 9 node cluster and automatically
 apply the geo-partitioned replicas topology across 3 virtual regions named
 us-east1, us-west1, and europe-west1. This command will fail with an error
 if an enterprise license could not be acquired, or if the Movr dataset is
 not used. More information about the geo-partitioned replicas topology can be
 found at:

https://www.cockroachlabs.com/docs/v26.1/topology-geo-partitioned-replicas.html

--global[=false]

Simulate a global cluster. This adds artificial latencies to nodes in
 different regions. This flag only works with the default node localities. This
 setting is experimental.

-h, --help[=false]
    help for recreate

--http-port=8080

First port number for HTTP servers. There should be as many TCP ports
 available as the value of --nodes starting at the specified value; for
 multitenant demo clusters, the number of required ports is twice the value of
 --nodes.

--insecure[=false]

Connect to a cluster without using TLS nor authentication. This makes the
 client-server connection vulnerable to MITM attacks. Use with care.
 Environment variable: COCKROACH_INSECURE

--listening-url-file=""

After the CockroachDB node has started up successfully, it will write its
 connection URL to the specified file.

--max-sql-memory=256 MiB

Maximum memory capacity available for each node to store temporary data for
 SQL clients, including prepared queries and intermediate data rows during
 query execution. Accepts numbers interpreted as bytes, size suffixes (e.g. 1GB
 and 1GiB) or a percentage of physical memory (e.g. .25). If left unspecified,
 defaults to 256MiB.

--name-gen-options=""

Use the specified options for the name generation during schema expansion
 (JSON syntax).

--no-line-editor[=false]

Force disable the interactive line editor. Can help during testing.

--nodes=1

How many in-memory nodes to create for the demo.

--pid-file=""

After the CockroachDB node has started up successfully, it will write its
 process ID to the specified file.

--placeholder=[]
    pass in a map of placeholder id to fully-qualified table column to get the program to produce all optimal of explain plans with each of the histogram values for each column replaced in its placeholder.

--read-only[=false]

Set the session variable default_transaction_read_only to on.

--safe-updates[=]

Disable SQL statements that may have undesired side effects. For example a
 DELETE or UPDATE without a WHERE clause. By default, this setting is enabled
 (true) and such statements are rejected to prevent accidents. This can also be
 overridden in a session with SET sql_safe_updates = FALSE.

--set=

Set a client-side configuration parameter before running the SQL shell. This
 flag may be specified multiple times.

--spatial-libs="/usr/local/lib/cockroach"

The location where all libraries for spatial operations is located.

--sql-port=26257

First port number for SQL servers. There should be as many TCP ports available
 as the value of --nodes starting at the specified value; for multitenant demo
 clusters, the number of required ports is twice the value of --nodes.

--watch=0s

Repeat the SQL statement(s) specified with --execute with the specified
 period. The client will stop watching if an execution of the SQL statement(s)
 fail.

--with-load[=false]

Run a demo workload against the pre-loaded database.

--workload-max-qps=25

The maximum QPS when a workload is running.

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-statement-bundle(1)

HISTORY

13-May-2026 Auto generated by spf13/cobra