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

     1  ---
     2  title: kbcli bench pgbench run
     3  ---
     4  
     5  Run pgbench against a PostgreSQL cluster
     6  
     7  ```
     8  kbcli bench pgbench run [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # pgbench run on a cluster
    15    kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx
    16    
    17    # pgbench run on a cluster with different threads and different client
    18    kbcli bench sysbench run  pgcluster --user xxx --password xxx --database xxx --clients 5 --threads 5
    19    
    20    # pgbench run on a cluster with specified transactions
    21    kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx --transactions 1000
    22    
    23    # pgbench run on a cluster with specified times
    24    kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx --times 1000
    25    
    26    # pgbench run on a cluster with select only
    27    kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx --select
    28  ```
    29  
    30  ### Options
    31  
    32  ```
    33        --clients int        The number of clients to use for pgbench (default 1)
    34    -h, --help               help for run
    35        --select             Run pgbench with select only
    36        --threads int        The number of threads to use for pgbench (default 1)
    37        --time int           The duration to run pgbench for
    38        --transactions int   The number of transactions to run for pgbench
    39  ```
    40  
    41  ### Options inherited from parent commands
    42  
    43  ```
    44        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    45        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    46        --as-uid string                  UID to impersonate for the operation.
    47        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    48        --certificate-authority string   Path to a cert file for the certificate authority
    49        --client-certificate string      Path to a client certificate file for TLS
    50        --client-key string              Path to a client key file for TLS
    51        --cluster string                 The name of the kubeconfig cluster to use
    52        --context string                 The name of the kubeconfig context to use
    53        --database string                database name
    54        --disable-compression            If true, opt-out of response compression for all requests to the server
    55        --host string                    the host of database
    56        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    57        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    58        --match-server-version           Require server version to match client version
    59    -n, --namespace string               If present, the namespace scope for this CLI request
    60        --password string                the password of database
    61        --port int                       the port of database
    62        --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")
    63    -s, --server string                  The address and port of the Kubernetes API server
    64        --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
    65        --token string                   Bearer token for authentication to the API server
    66        --user string                    the user of database
    67  ```
    68  
    69  ### SEE ALSO
    70  
    71  * [kbcli bench pgbench](kbcli_bench_pgbench.md)	 - Run pgbench against a PostgreSQL cluster
    72  
    73  #### Go Back to [CLI Overview](cli.md) Homepage.
    74