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 GET databases 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?user_id=username&passwd=username_password |
Response:
This API call returns over 100 configuration parameters.. The following response is a small subset of the total amount returned.
[ { "node_name": "ALL", "parameter_name": "ACDAlgorithmForSynopsisVersion1", "current_value": "1", "restart_value": "1", "database_value": "1", "default_value": "1", "current_level": "DEFAULT", "restart_level": "DEFAULT", "is_mismatch": "f", "groups": "", "allowed_levels": "SESSION, DATABASE", "superuser_visible_only": "f", "change_under_support_guidance": "t", "change_requires_restart": "f", "description": "Algorithm used to interpret synopsis version 1 for approximate count distinct" }, { "node_name": "ALL", "parameter_name": "ACDLinearCountThreshold", "current_value": "-1.000000", "restart_value": "-1.000000", "database_value": "-1.000000", "default_value": "-1.000000", "current_level": "DEFAULT", "restart_level": "DEFAULT", "is_mismatch": "f", "groups": "", "allowed_levels": "SESSION, DATABASE", "superuser_visible_only": "f", "change_under_support_guidance": "t", "change_requires_restart": "f", "description": "If positive, will overwrite the default linear counting threshold in approximate count distinct" }, { "node_name": "ALL", "parameter_name": "ACDSynopsisVersion", "current_value": "2", "restart_value": "2", "database_value": "2", "default_value": "2", "current_level": "DEFAULT", "restart_level": "DEFAULT", "is_mismatch": "f", "groups": "", "allowed_levels": "SESSION, DATABASE", "superuser_visible_only": "f", "change_under_support_guidance": "t", "change_requires_restart": "f", "description": "Default synopsis version to be generated by approximate count distinct" }, { "node_name": "ALL", "parameter_name": "AHMBackupManagement", "current_value": "0", "restart_value": "0", "database_value": "0", "default_value": "0", "current_level": "DEFAULT", "restart_level": "DEFAULT", "is_mismatch": "f", "groups": "", "allowed_levels": "NODE, DATABASE", "superuser_visible_only": "f", "change_under_support_guidance": "t", "change_requires_restart": "f", "description": "Consider backup epochs when setting new AHM" }, { "node_name": "ALL", "parameter_name": "ARCCommitPercentage", "current_value": "3.000000", "restart_value": "3.000000", "database_value": "3.000000", "default_value": "3.000000", "current_level": "DEFAULT", "restart_level": "DEFAULT", "is_mismatch": "f", "groups": "", "allowed_levels": "DATABASE", "superuser_visible_only": "f", "change_under_support_guidance": "t", "change_requires_restart": "f", "description": "ARC will commit only if the change is more than the percentage specified" }, { "node_name": "ALL", "parameter_name": "AWSCAFile", "current_value": "", "restart_value": "", "database_value": "", "default_value": "", "current_level": "DEFAULT", "restart_level": "DEFAULT", "is_mismatch": "f", "groups": "", "allowed_levels": "DATABASE", "superuser_visible_only": "f", "change_under_support_guidance": "f", "change_requires_restart": "f", "description": "Overrides the default CA file" }, ... ]