Query manager database configuration

This document provides guidelines for configuring the Query Manager database in CloudBeaver using the server configuration file.

Info

For more information on Query Manager, see Query Manager. For more details on configuration, see the CloudBeaver server configuration.

Note

If the Query Manager database is configured using environment variables during application deployment, these settings may not be visible in the configuration file.

Example configuration

The Query Manager database configuration is located under the qm section of the main server configuration file.

qm: {
    driver: "${CLOUDBEAVER_QM_DB_DRIVER:postgres-jdbc}",
    url: "${CLOUDBEAVER_QM_DB_URL:jdbc:postgresql://postgres:5432/cloudbeaver}",
    user: "${CLOUDBEAVER_QM_DB_USER:''}",
    password: "${CLOUDBEAVER_QM_DB_PASSWORD:''}",
    schema: "${CLOUDBEAVER_QM_DB_SCHEMA:''}",
    pool: {
        minIdleConnections: "${CLOUDBEAVER_QM_DB_MIN_IDLE_CONNECTIONS:4}",
        maxIdleConnections: "${CLOUDBEAVER_QM_DB_MAX_IDLE_CONNECTIONS:10}",
        maxConnections: "${CLOUDBEAVER_QM_DB_MAX_CONNECTIONS:100}",
        validationQuery: "${CLOUDBEAVER_QM_DB_VALIDATION_QUERY:SELECT 1}"
        },
    backupEnabled: "${CLOUDBEAVER_QM_DB_BACKUP_ENABLED:true}"
}

Configuration properties

Name	Environment variable	Default value	Units	Description
driver	CLOUDBEAVER_QM_DB_DRIVER	postgres-jdbc	string	Database driver ID for the Query Manager database: - PostgreSQL (recommended) - postgres-jdbc - MariaDB - mariaDB - Oracle - oracle_thin - SQL Server - mssql - H2 - h2_embedded
url	CLOUDBEAVER_QM_DB_URL	jdbc:postgresql://postgres:5432/cloudbeaver	string	Database JDBC URL (e.g., jdbc:postgresql://localhost:5432/qm).
user	CLOUDBEAVER_QM_DB_USER	''	string	Database user name.
password	CLOUDBEAVER_QM_DB_PASSWORD	''	string	Database user password.
schema	CLOUDBEAVER_QM_DB_SCHEMA	''	string	Database schema.
minIdleConnections	CLOUDBEAVER_QM_DB_MIN_IDLE_CONNECTIONS	4	number	Minimum idle connections for the connection pool.
maxIdleConnections	CLOUDBEAVER_QM_DB_MAX_IDLE_CONNECTIONS	10	number	Maximum idle connections for the connection pool.
maxConnections	CLOUDBEAVER_QM_DB_MAX_CONNECTIONS	100	number	Maximum total connections in the pool.
validationQuery	CLOUDBEAVER_QM_DB_VALIDATION_QUERY	SELECT 1	string	Query to validate connections.
backupEnabled	CLOUDBEAVER_QM_DB_BACKUP_ENABLED	true	boolean	Enables or disables backup of the Query Manager database.