GET databases/:database_name/configuration

Returns a list of configuration parameters for the database identified by :database_name. The :database_name is the value of the name field that the GETdatabases command returns.

Resource URL

https://<NODE>:5444/databases/:database_name/configuration

Authentication

Requires a VerticaAPIKey in the request header.

The API key must have restricted level security or higher.

Parameters

user_id
A database username.
passwd
The password for the username.

Example Request

GET
https://<NODE>:5444/databases/testDB/configuration

Response:

This API call returns over 100 configuration parameters.. The following response is a small subset of the total amount returned.

[
    {
        "catalog_value": "1",
        "change_requires_restart": "f",
        "change_under_support_guidance": "f",
        "current_value": "1",
        "database_value": "1",
        "default_value": "1",
        "description": "No of active partitions",
        "groups": "",
        "is_mismatch": "f",
        "node_name": "ALL",
        "parameter_name": "ActivePartitionCount",
        "source": "DEFAULT"
    },
    {
        "catalog_value": "180",
        "change_requires_restart": "f",
        "change_under_support_guidance": "f",
        "current_value": "180",
        "database_value": "180",
        "default_value": "180",
        "description": "Interval between advancing the AHM (seconds)",
        "groups": "",
        "is_mismatch": "f",
        "node_name": "ALL",
        "parameter_name": "AdvanceAHMInterval",
        "source": "DEFAULT"
    },
    {
        "catalog_value": "3",
        "change_requires_restart": "f",
        "change_under_support_guidance": "f",
        "current_value": "3",
        "database_value": "3",
        "default_value": "3",
        "description": "HDFS replication factor for Vertica data",
        "groups": "",
        "is_mismatch": "f",
        "node_name": "ALL",
        "parameter_name": "HadoopFSReplication",
        "source": "DEFAULT"
    },
    {
        "catalog_value": "",
        "change_requires_restart": "f",
        "change_under_support_guidance": "f",
        "current_value": "",
        "database_value": "",
        "default_value": "",
        "description": "Path to the java binary for executing UDx written in Java",
        "groups": "",
        "is_mismatch": "f",
        "node_name": "ALL",
        "parameter_name": "JavaBinaryForUDx",
        "source": "DEFAULT"
    },
    {
        "catalog_value": "80",
        "change_requires_restart": "f",
        "change_under_support_guidance": "f",
        "current_value": "80",
        "database_value": "80",
        "default_value": "80",
        "description": "The max amount of memory TopK(Heap) can use in MB",
        "groups": "",
        "is_mismatch": "f",
        "node_name": "ALL",
        "parameter_name": "TopKHeapMaxMem",
        "source": "DEFAULT"
    },
    {
        "catalog_value": "READ COMMITTED",
        "change_requires_restart": "f",
        "change_under_support_guidance": "f",
        "current_value": "READ COMMITTED",
        "database_value": "READ COMMITTED",
        "default_value": "READ COMMITTED",
        "description": "READ COMMITTED (Default) - Last epoch for reads and current epoch for writes.  
SERIALIZABLE - Current epoch for reads and writes",
        "groups": "",
        "is_mismatch": "f",
        "node_name": "ALL",
        "parameter_name": "TransactionIsolationLevel",
        "source": "DEFAULT"
    }
]