github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/kbcli_bench_ycsb.md (about)

     1  ---
     2  title: kbcli bench ycsb
     3  ---
     4  
     5  Run YCSB benchmark on a cluster
     6  
     7  ```
     8  kbcli bench ycsb [Step] [BenchmarkName] [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # ycsb on a cluster,  that will exec for all steps, cleanup, prepare and run
    15    kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb
    16    
    17    # ycsb on a cluster with cleanup, only cleanup by deleting the testdata
    18    kbcli bench ycsb cleanup mytest --cluster mycluster --user xxx --password xxx --database mydb
    19    
    20    # ycsb on a cluster with prepare, just prepare by creating the testdata
    21    kbcli bench ycsb prepare mytest --cluster mycluster --user xxx --password xxx --database mydb
    22    
    23    # ycsb on a cluster with run, just run by running the test
    24    kbcli bench ycsb run mytest --cluster mycluster --user xxx --password xxx --database mydb
    25    
    26    # ycsb on a cluster with thread counts
    27    kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb --threads 4,8
    28    
    29    # ycsb on a cluster with record number and operation number
    30    kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb --record-count 10000 --operation-count 10000
    31    
    32    # ycsb on a cluster mixed read/write
    33    kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb --read-proportion 50 --update-proportion 50
    34  ```
    35  
    36  ### Options
    37  
    38  ```
    39        --cluster string                     the cluster of database
    40        --database string                    database name
    41        --driver string                      the driver of database
    42        --extra-args strings                 extra arguments for benchmark
    43    -h, --help                               help for ycsb
    44        --host string                        the host of database
    45        --insert-proportion int              the percentage of insert operations in benchmark
    46        --operation-count int                the number of operations to use during the run phase (default 1000)
    47        --password string                    the password of database
    48        --port int                           the port of database
    49        --read-modify-write-proportion int   the percentage of read-modify-write operations in benchmark, which read a record, modify it, and write it back
    50        --read-proportion int                the percentage of read operations in benchmark
    51        --record-count int                   the number of records to use (default 1000)
    52        --scan-proportion int                the percentage of scan operations in benchmark
    53        --threads ints                       the number of threads to use (default [1])
    54        --tolerations strings                Tolerations for benchmark, such as '"dev=true:NoSchedule,large=true:NoSchedule"'
    55        --update-proportion int              the percentage of update operations in benchmark
    56        --user string                        the user of database
    57  ```
    58  
    59  ### Options inherited from parent commands
    60  
    61  ```
    62        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    63        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    64        --as-uid string                  UID to impersonate for the operation.
    65        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    66        --certificate-authority string   Path to a cert file for the certificate authority
    67        --client-certificate string      Path to a client certificate file for TLS
    68        --client-key string              Path to a client key file for TLS
    69        --context string                 The name of the kubeconfig context to use
    70        --disable-compression            If true, opt-out of response compression for all requests to the server
    71        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    72        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    73        --match-server-version           Require server version to match client version
    74    -n, --namespace string               If present, the namespace scope for this CLI request
    75        --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
    76    -s, --server string                  The address and port of the Kubernetes API server
    77        --tls-server-name string         Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
    78        --token string                   Bearer token for authentication to the API server
    79  ```
    80  
    81  ### SEE ALSO
    82  
    83  * [kbcli bench](kbcli_bench.md)	 - Run a benchmark.
    84  
    85  #### Go Back to [CLI Overview](cli.md) Homepage.
    86