Product configuration parameters

Table of contents

• Overview
• Example configuration
• Configuration properties
  • Interface
  • Log viewer
  • SQL editor
  • SQL proposals
  • Additional product settings

Overview

This document provides guidelines for configuring core product settings in CloudBeaver. These settings control localization, themes, logging, the SQL editor, and more.

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

Example configuration

The Product settings configuration is located under the productSettings section of the main server configuration file.

productSettings: {
    "core.localization.localization": "${CLOUDBEAVER_CORE_LOCALIZATION:en}",
    "core.theming.theme": "${CLOUDBEAVER_CORE_THEMING_THEME:light}",
    "plugin.log-viewer.disabled": "${CLOUDBEAVER_LOG_VIEWER_DISABLED:false}",
    "plugin.log-viewer.logBatchSize": "${CLOUDBEAVER_LOG_VIEWER_LOG_BATCH_SIZE:2}",
    "plugin.log-viewer.maxLogRecords": "${CLOUDBEAVER_LOG_VIEWER_MAX_LOG_RECORDS:2000}",
    "plugin.sql-editor.autoSave": "${CLOUDBEAVER_SQL_EDITOR_AUTOSAVE:true}",
    "plugin.sql-editor.disabled": "${CLOUDBEAVER_SQL_EDITOR_DISABLED:false}",
    "plugin.sql-editor.maxFileSize": "${CLOUDBEAVER_SQL_EDITOR_MAX_FILE_SIZE:10240}",
    "sql.proposals.insert.table.alias": "${CLOUDBEAVER_SQL_PROPOSALS_INSERT_TABLE_ALIAS:PLAIN}"
},

Configuration properties

Interface

Name	Environment variable	Description	Allowed values
core.localization.localization	CLOUDBEAVER_CORE_LOCALIZATION	Default language for the interface.	See Languages.
core.theming.theme	CLOUDBEAVER_CORE_THEMING_THEME	Default application theme.	See Themes.

Log viewer

Name	Environment variable	Description	Allowed values
plugin.log-viewer.disabled	CLOUDBEAVER_LOG_VIEWER_DISABLED	Disables the log viewer plugin.	true, false
plugin.log-viewer.logBatchSize	CLOUDBEAVER_LOG_VIEWER_LOG_BATCH_SIZE	Number of log entries retrieved per request.	Integer
plugin.log-viewer.maxLogRecords	CLOUDBEAVER_LOG_VIEWER_MAX_LOG_RECORDS	Maximum number of log records stored.	Integer

For more details on logging, see Log viewer.

SQL editor

Name	Environment variable	Description	Allowed values
plugin.sql-editor.autoSave	CLOUDBEAVER_SQL_EDITOR_AUTOSAVE	Enables auto-saving for SQL editor sessions.	true, false
plugin.sql-editor.disabled	CLOUDBEAVER_SQL_EDITOR_DISABLED	Disables the SQL editor plugin.	true, false
plugin.sql-editor.maxFileSize	CLOUDBEAVER_SQL_EDITOR_MAX_FILE_SIZE	Maximum file size (in bytes) for importing files in the SQL editor.	Integer

For more details on SQL Editor, see our documentation.

SQL proposals

Name	Environment variable	Description	Allowed values
sql.proposals.insert.table.alias	CLOUDBEAVER_SQL_PROPOSALS_INSERT_TABLE_ALIAS	Default alias format for table insert proposals.	PLAIN, SHORT, FULL

Additional product settings

• Authentication settings
• Connection settings
• Data export settings
• Data spreadsheet settings
• ERD settings
• Navigation tree settings