SHOW CONFIGS / CONFIG command

The SHOW CONFIGS command lists all runtime configuration options for the connected Graph service or a specified Storage service within the current session.

Note

SHOW CONFIGS only displays runtime configuration options of the Graph service and Storage service. Configuration options defined in TOML files under the <install_path>/plugins directory are not included. To view plugin configurations, see the corresponding plugin TOML configuration files directly.

SHOW CONFIGS

Returns all runtime configuration options for the connected Graph service within the current session.

SHOW CONFIGS "<storage_ip_port>"

Returns all runtime configuration options for the specified Storage service within the current session.

To view a specific configuration option, you can use SHOW CONFIG.

SHOW CONFIG <config_option>

Returns the specified runtime configuration option for the connected Graph service within the current session.

SHOW CONFIG "<storage_ip_port>" <config_option>

Returns the specified runtime configuration option for the specific Storage service within the current session.

The following table describes the returned information:

Column	Description
name	The name of the configuration option.
type	The data type of the configuration option.
value	The runtime value of the configuration option.
default_value	The default value of the configuration option.
scope	The type of the configuration option. Valid values: GLOBAL, SERVICE, and SESSION.
deprecated	Whether the configuration option is deprecated. Valid values are: false: indicates that the option is not deprecated. true: indicates that it is deprecated.
mutable	Whether the configuration option supports dynamic modification at runtime. Valid values are: false: indicates that the option cannot be dynamically modified. true: indicates that it can be dynamically modified.
since	The NebulaGraph Database Developer Edition version in which the configuration option was introduced.
description	The description of the configuration option.

Syntax

diagramsource

show_configs_command

show_config_command

show_configs_command ::=
    'SHOW' 'CONFIGS' ('"'storage_ip_port'"')?
show_config_command ::=
    'SHOW' 'CONFIG' ('"'storage_ip_port'"')? config_option

Parameters

storage_ip_port

The IP address and port number of the Storage service whose configuration is to be viewed. If specified, it must be enclosed in single or double quotes.

config_option

The name of the specified configuration option to be viewed.

Examples

View all runtime configuration options for the current connected Graph service

SHOW CONFIGS \G

Return:

...
*************************** 4. row ***************************
         name: date_format
         type: STRING
        value: %Y-%m-%d
default_value: %Y-%m-%d
        scope: SESSION
   deprecated: false
      mutable: true
        since: 5.0.0
  description: format string for date
*************************** 5. row ***************************
...

View a specific runtime configuration option for the current connected Graph service

SHOW CONFIG session_idle_timeout_secs

Return:

+---------------------------+-------+-------+---------------+---------+------------+---------+-------+-------------------------------------------+
| name                      | type  | value | default_value | scope   | deprecated | mutable | since | description                               |
+---------------------------+-------+-------+---------------+---------+------------+---------+-------+-------------------------------------------+
| session_idle_timeout_secs | INT64 | 28800 | 28800         | SERVICE | false      | false   | 5.0.0 | Maximum idle time of a session in seconds |
+---------------------------+-------+-------+---------------+---------+------------+---------+-------+-------------------------------------------+

View all runtime configuration options for a specified Storage service

SHOW CONFIGS "192.168.8.129:9779" \G

Return:

*************************** 1. row ***************************
         name: ann_index_memory_quota_in_kb
         type: INT64
        value: -1
default_value: -1
        scope: SERVICE
   deprecated: false
      mutable: false
        since: 5.0.0
  description: The memory quota(in KB) for all ANN indexes in every storaged process, the default value of -1 means no memory limit
*************************** 2. row ***************************
...

View a specific runtime configuration option for a specified Storage service

SHOW CONFIG "192.168.8.129:9779" audit_log_enabled

Return:

+-------------------+------+-------+---------------+---------+------------+---------+-------+-------------------------+
| name              | type | value | default_value | scope   | deprecated | mutable | since | description             |
+-------------------+------+-------+---------------+---------+------------+---------+-------+-------------------------+
| audit_log_enabled | BOOL | true  | true          | SERVICE | false      | false   | 5.0.0 | Enable audit log or not |
+-------------------+------+-------+---------------+---------+------------+---------+-------+-------------------------+