COCKROACH-WORKLOAD-INIT-YCSB(1)

NAME

cockroach-workload-init-ycsb - YCSB is the Yahoo! Cloud Serving Benchmark.

SYNOPSIS

cockroach workload init ycsb [pgurl...] [flags]

DESCRIPTION

YCSB is the Yahoo! Cloud Serving Benchmark.

OPTIONS

--concurrency=40
    Number of concurrent workers

--conn-healthcheck-period=30s
    Interval that health checks are run on connections

--conn-vars=[]
    Session variables to configure on database connections

--data-loader="AUTO"
    How to load initial table data. All workloads support INSERT; some support IMPORT, which AUTO prefers if available.

--db=""
    Override for the SQL database to use. If empty, defaults to the generator name

--delete-freq=0
    Percentage of deletes in the workload. Used in conjunction with --workload=CUSTOM to specify an alternative workload mix. (default 0.0)

--dns-refresh=30s
    Interval used to refresh cached DNS entries ( disables)

--drop[=false]
    Drop the existing database, if it exists

--families[=true]
    Place each column in its own column family.

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

--init-conns=16
    The number of connections to use during INSERT init

--insert-count=10000
    Number of rows to sequentially insert before beginning workload.

--insert-freq=0
    Percentage of inserts in the workload. Used in conjunction --workload=CUSTOM to specify an alternative workload mix. (default 0.0)

--insert-random[=true]
    Key to be pseduorandom or ordered.

--insert-start=0
    Key to start initial sequential insertions from. (default 0)

--isolation-level=""
    Isolation level to run workload transactions under [serializable, snapshot, read_committed]. If unset, the workload will run with the default isolation level of the database.

--json[=false]
    Use JSONB rather than relational data.

--max-conn-idle-time=2m30s
    Max time an idle connection will be kept around

--max-conn-lifetime=5m0s
    Max connection lifetime

--max-conn-lifetime-jitter=2m30s
    Jitter max connection lifetime by this amount

--max-scan-length=1000
    The maximum length for scan operations. Primarily used for workload E.

--method="cache_statement"
    SQL issue method (cache_statement, cache_describe, describe_exec, exec, simple_protocol)

--min-conns=0
    Minimum number of connections to attempt to keep in the pool

--min-scan-length=1
    The minimum length for scan operations. Primarily used for workload E.

--operation-receiver=""
    Optional ip address:port to send latency operation metrics.

--password=""
    Optionally specify a password for the user

--prometheus-port=2112
    Port to expose prometheus metrics if the workload has a prometheus gatherer set.

--read-freq=0
    Percentage of reads in the workload. Used in conjunction with --workload=CUSTOM to specify an alternative workload mix. (default 0.0)

--read-modify-write-freq=0
    Percentage of read-modify-writes in the workload. Used in conjunction with --workload=CUSTOM to specify an alternative workload mix. (default 0.0)

--read-modify-write-in-txn[=false]
    Run workload F's read-modify-write operation in an explicit transaction.

--record-count=0
    Key to start workload insertions from. Must be >= insert-start + insert-count. (Default: insert-start + insert-count)

--request-distribution=""
    Distribution for request key generation [zipfian, uniform, latest]. The default for workloads A, B, C, E, F and CUSTOM is zipfian, and the default for workload D is latest.

--scan-freq=0
    Percentage of scans in the workload. Used in conjunction with --workload=CUSTOM to specify an alternative workload mix. (default 0.0)

--scan-length-distribution="uniform"
    Distribution for scan length generation [zipfian, uniform]. Primarily used for workload E.

--secure[=false]
    Run in secure mode (sslmode=require). Running in secure mode expects the relevant certs to have been created for the user in the certs/ directory.For example when using root, certs/client.root.crt certs/client.root.key should exist.

--seed=12284880492576370667
    Random seed. Default changes in each run

--select-for-update[=true]
    Use SELECT FOR UPDATE syntax in read-modify-write operation, if run in an explicit transactions.

--splits=0
    Number of splits to perform before starting normal operations.

--time-string[=false]
    Prepend field[0-9] data with current time in microsecond precision.

--update-freq=0
    Percentage of updates in the workload. Used in conjunction with --workload=CUSTOM to specify an alternative workload mix. (default 0.0)

--user="root"
    Specify a user to run the workload as

--warmup-conns=0
    Number of connections to warmup in each connection pool

--workload="B"
    Workload type. Choose from A-F or CUSTOM. (default B)

--zero-padding=1
    Key has zeros padded to left to make this length of digits.

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-workload-init(1)

HISTORY

13-May-2026 Auto generated by spf13/cobra