Skip to content

Query manager database configuration

dbeaver-devops edited this page Oct 25, 2024 · 5 revisions

Table of contents

Overview

This document provides guidelines for configuring the Query Manager database in CloudBeaver.

For more information on Query Manager, see Query Manager.

For more details on configuration, see the CloudBeaver server configuration.

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:h2_embedded_v2}",
    url: "${CLOUDBEAVER_QM_DB_URL:jdbc:h2:${workspace}/.metadata/qmdb/qmdb}",
    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 Description
driver CLOUDBEAVER_QM_DB_DRIVER Database driver (e.g., postgres-jdbc, oracle-thin, etc.).
url CLOUDBEAVER_QM_DB_URL Database JDBC URL (e.g., jdbc:postgresql://localhost:5432/qm).
user CLOUDBEAVER_QM_DB_USER Database user name.
password CLOUDBEAVER_QM_DB_PASSWORD Database user password.
schema CLOUDBEAVER_QM_DB_SCHEMA Database schema.
minIdleConnections CLOUDBEAVER_QM_DB_MIN_IDLE_CONNECTIONS Minimum idle connections for the connection pool.
maxIdleConnections CLOUDBEAVER_QM_DB_MAX_IDLE_CONNECTIONS Maximum idle connections for the connection pool.
maxConnections CLOUDBEAVER_QM_DB_MAX_CONNECTIONS Maximum total connections in the pool.
validationQuery CLOUDBEAVER_QM_DB_VALIDATION_QUERY Query to validate connections.
backupEnabled CLOUDBEAVER_QM_DB_BACKUP_ENABLED Enables/disables backup of the Query Manager database.

CloudBeaver Documentation

User Guide

Installation

Configuration

CloudBeaver AWS

CloudBeaver Enterprise Edition

Team Edition

Deployment

Clone this wiki locally