A newer version of this documentation is available.

View Latest

setting-query

    +

    Manage query engine settings

    SYNOPSIS

    _couchbase-cli setting-query [--cluster <url>] [--username <user>]
        [--password <password>] [--get] [--set] [--pipeline-batch <num>]
        [--pipeline-cap <num>] [--scan-cap <size>] [--timeout <ms>]
        [--prepared-limit <max>] [--completed-limit <max>]
        [--log-level <trace|debug|info|warn|error|server|none>]
        [--max-parallelism <max>] [--n1ql-feature-control <num>]

    DESCRIPTION

    Manage query service settings

    OPTIONS

    -c
    --cluster

    Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

    -u
    --user <username>

    Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

    -p
    --password <password>

    Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

    --get

    Retrieve current query service settings.

    --set

    Set query engine settings.

    --pipeline-batch <num>

    Number of items execution operators can batch, the default is 16.

    --pipeline-cap <num>

    Maximum number of items each execution operator can buffer, the default 512.

    --scan-cap <size>

    Maximum buffer size for index scans; use zero or negative value to disable. The default 512.

    --timeout <ms>

    Server execution timeout; use zero or negative value to disable. By default is unlimited.

    --prepared-limit <max>

    Maximum number of prepared statements, the default is 16384.

    --completed-limit <max>

    Maximum number of completed requests, the default is 4000.

    --log-level <trace|debug|info|warn|error|server|none>

    Query engine log level, the default level is info.

    --max-parallelism <max>

    Maximum parallelism per query; use zero or negative value to disable. The default is 1.

    --n1ql-feature-control <num>

    N1QL Feature Controls. 0x0001 (1) Disable Index Aggregation

    HOST FORMATS

    When specifying a host for the couchbase-cli command the following formats are expected:

    • couchbase://<addr>

    • <addr>:<port>

    • http://<addr>:<port>

    It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

    EXAMPLES

    To retrieve the query settings:

    $ couchbase-cli setting-query -c 127.0.01:8091 -u Administrator \
     -p password --get

    To set any of the query settings for example maximum parallelism and log level:

    $ couchbase-cli setting-query -c 127.0.01:8091 -u Administrator \
     -p password --set --log-level debug --max-parallelism 4

    ENVIRONMENT AND CONFIGURATION VARIABLES

    CB_REST_USERNAME

    Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

    CB_REST_PASSWORD

    Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

    SEE ALSO

    COUCHBASE-CLI

    Part of the couchbase-cli suite