# Dbeaver > * [First steps](../Getting-started/) --- # Source: https://dbeaver.com/docs/dbeaver/AI-Assistance-and-Data-Privacy/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * Data privacy [ Data privacy ](./) Table of contents * Privacy policy * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Privacy policy 1. [DBeaver](/docs/dbeaver) 2. AI # Data privacy We prioritize data safety and user privacy. In this section, we outline how data is managed and the measures taken to protect user privacy when using the AI Assistant. To enable the AI Assistant capabilities, table and column names from the current database schema are transmitted to AI provider. This step is crucial for accurately translating user requests into SQL queries. Key considerations regarding data privacy are as follows: * **Data sharing options** : By default, only table and column names are sent to AI provider. * **User Consent** : On the first use of AI completion for a specific connection, DBeaver will prompt for your confirmation to send metadata. This confirmation is mandatory to use the feature. ![](../images/ai/ai_smart_assistance_9.png) * **Log Transparency** : The entire request can be logged for your review. To enable this, navigate to **Preferences** and check the **Write GPT queries to debug log** option. * **Selective Metadata Sharing** : If you prefer not to share information about certain tables, adjust the tables in scope using the **Scope** field. ## Privacy policy¶ In addition to these general principles, each AI provider applies its own privacy policy: Provider | Privacy policy ---|--- **OpenAI** | Requests are processed under the [OpenAI privacy policy](https://openai.com/policies/privacy-policy). **GitHub Copilot** | Copilot follows the [GitHub privacy statement](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement). **Azure OpenAI** | Operates under its own [privacy policy](https://learn.microsoft.com/en-us/legal/cognitive-services/openai/data-privacy). It's recommended to review their terms. **Google Gemini** | Data is handled according to [Gemini privacy measures](https://ai.google.dev/terms). **Ollama** | Ollama follows a local-first design: all AI processing happens on your machine or a self-hosted/company server, and prompts, code, or documents never leave your computer. **Anthropic Claude** | Requests are processed according to [Anthropic’s privacy policy](https://www.anthropic.com/legal/privacy). Review their terms to understand how your data is handled. **Amazon Bedrock** | Requests are processed under the [AWS privacy notice](https://aws.amazon.com/privacy/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-Assistance-settings/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * AI Assistant settings [ AI Assistant settings ](./) Table of contents * AI Assistant setup * AI Chat configuration * AI Configuration * General * SQL Completion * AI query execution * Send database structure * Scope settings * Automatic prompt reduction * Functions * Available functions * Data transfer actions * Advanced metadata read * View and editor actions * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * AI Assistant setup * AI Chat configuration * AI Configuration * General * SQL Completion * AI query execution * Send database structure * Scope settings * Automatic prompt reduction * Functions * Available functions * Data transfer actions * Advanced metadata read * View and editor actions 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. Settings # AI Assistant settings Use this page to configure the general behavior of AI in DBeaver. ![](../images/ai/ai-token-settings.png) ## AI Assistant setup¶ Note AI Assistant is turned on by default. If it was disabled earlier, you can re- enable it in **Window - > Preferences -> General -> AI** by selecting **Enable AI integration**. To activate AI Assistant, open **Window - > Preferences -> General -> AI** and select your provider from the **Service** dropdown menu. Next, set up your [provider](../AI-Smart-Assistance/#supported-providers). ## AI Chat configuration¶ For configuring AI Chat settings, navigate to **Window - > Preferences -> General -> AI -> AI Chat**. Setting | Description | Default ---|---|--- **Use web browser view** | Enables modern renderer for AI Chat, based on web technologies. Otherwise oses old renderer in OS-native widgets. | On **Use stream mode** | Enables data to load and display progressively as it’s received from the server, instead of waiting for the entire response. This improves responsiveness and reduces memory usage when working with large result sets. Available only if supported by the selected AI provider. | Off **Days to keep chats** | Sets how many days chat history is stored locally. Older chats will be deleted automatically. | `7` **Silence threshold** | Defines the minimum sound level that’s considered speech. Lower values make recognition more sensitive to quiet voices, but may include background noise. | `0.3`% **Silence timeout** | Sets how long to wait (in seconds) after silence before ending the transcription. | `20` sec **Audio max duration** | Limits the maximum length of recorded audio for transcription. Longer recordings are automatically trimmed. | `60` sec Important If you add [filters](../Configure-Filters/) in the [Database Navigator](../Database-Navigator/), only the filtered tables are sent to the AI. The same applies in the Data Editor — if you filter tables, they won’t appear in completion or be validated correctly in queries, because if they’re not in the navigator, there’s no metadata about them. ## AI Configuration¶ For configuring specific settings, navigate to **Window - > Preferences -> General -> AI -> AI Configuration**. ### General¶ Setting | Description | Default ---|---|--- **Language** | Choose the language for AI responses. This affects the language used in answers, explanations, and code comments. | English Info Besides the listed options, you can also type in a language that's not included in the dropdown menu. ### SQL Completion¶ Setting | Description | Default ---|---|--- **Include source in query comment** | Shows your original request above the AI-generated query in the SQL Editor. | Off **Format SQL query** | Adds formatting to the generated SQL. Uses database-default case. | Off **Table join rule** | Choose between explicit JOIN or JOIN with sub-queries. | Default **Execute SQL immediately** | Runs the translated SQL query immediately after generation. | Off **Enable AI query suggestion** | Triggers smart SQL text suggestions using a shortcut. Suggestions are based on the current query and comments. | On ### AI query execution¶ These settings control how AI-generated SQL queries are executed. You can choose to run them immediately, show a confirmation prompt, or disable autocommit so changes must be committed manually. Setting | Description | Options | Default ---|---|---|--- **Select** | Controls execution of `SELECT` queries. | \- **Execute immediately** \- run `SELECT` queries without confirmation. \- **Show confirmation** \- ask for confirmation before executing. | Execute immediately **Modify** | Controls execution of data modification queries (`INSERT`, `DELETE`, `UPDATE`). | \- **Execute immediately** \- run modification queries without confirmation. \- **Show confirmation** \- ask for confirmation before executing. \- **Disable autocommit** \- turn off autocommit so changes require manual commit. | Show confirmation **Schema** | Controls execution of schema modification queries (`CREATE`, `DROP`, `ALTER`, etc.). | \- **Execute immediately** \- run schema modification queries without confirmation. \- **Show confirmation** \- ask for confirmation before executing. | Show confirmation **Other** | Controls execution of queries DBeaver cannot classify as valid SQL (including NoSQL queries). | \- **Execute immediately** \- run unknown or unclassified queries without confirmation. \- **Show confirmation** \- ask before executing queries not recognized as SQL. | Show confirmation Tip For the [AI command](../AI-command/), using **Show confirmation** is strongly recommended. It lets you preview the generated SQL in a dialog before execution, so you can review or cancel risky changes. ### Send database structure¶ Setting | Description | Default ---|---|--- **Send column data type information** | Sends column data types (like `INT`, `VARCHAR`, etc.) to the AI provider. Improves completion quality, but consumes more tokens. | On **Send object description** | Sends object description to the AI provider. Improves completion, but may consume significant amount of tokens. | Off **Send foreign keys information** | Helps AI understand table relationships. | Off **Send unique and primary keys information** | Sends unique and primary key metadata to the AI provider. Improves the quality of query generation, especially for joins and constraints, but uses more tokens. | Off ### Scope settings¶ ![tag-outline](/docs/includes/icons/tag-outline.svg) Available since 25.3 Setting | Description | Default ---|---|--- **Send only relevant objects to AI** | This option enables Retrieval-Augmented Generation behavior (RAG). When it’s on, DBeaver looks at your request and sends only the tables, columns, or other objects that are actually needed for the answer. This keeps responses faster, reduces token usage, and helps the assistant build replies based on real, relevant data instead of your full schema. | Off Note RAG works only with the [OpenAI](../AI-integration-with-OpenAI/) provider. ### Automatic prompt reduction¶ When sending database metadata and sample data to the AI provider, the amount of information is limited by the selected context size. If the content exceeds this limit, DBeaver automatically shortens the prompt in two steps: 1. Removes extra details (data types, keys, constraints, sample data) if all are enabled and the size is too large. 2. If it’s still too large, trims the snapshot until it fits the context limit. ## Functions¶ ![tag-outline](/docs/includes/icons/tag-outline.svg) Available since 25.3 Configure callable AI functions in **Window - > Preferences -> General -> AI -> Functions**. Use this page to control which actions the AI Assistant can perform automatically. When a function is enabled, the assistant can trigger internal operations like exporting data, comparing schemas, opening editors, or navigating the interface. ![](../images/ai/ai-functions-settings.png) Tip For information on enabling AI Assistant, see _AI Assistant settings_. ### Available functions¶ Enable or disable individual functions within each category. Disabled functions are ignored even if your prompt matches the action. ## Data transfer actions¶ These functions let AI Assistant work with data movement, comparison, and export. Function | Description ---|--- **Compare data** | Opens the **Data Compare** wizard to analyze differences between tables or databases. **Compare schemas** | Opens the **Schema Compare** wizard to compare database structures. **Export query results to a file** | Exports query results to a file using the **Data Transfer** wizard. **Export table data to a file** | Exports selected tables to a file using the **Data Transfer** wizard. **Import data** | Opens the **Data Transfer** wizard to import data from external files into selected tables. **Transfer data between tables** | Copies data from one table to another using the **Data Transfer** wizard. ## Advanced metadata read¶ This function lets AI Assistant read a small amount of sample data or metadata to improve query generation and mapping. Function | Description ---|--- **Read table sample rows** | Reads several rows from a table to understand its structure and suggest better queries or mappings. Note If you don’t enable these functions, DBeaver won’t send any database data to the AI. To send only structure metadata, see Send database structure. ## View and editor actions¶ These functions let AI Assistant interact with the interface, open and close views, and manage editors or connections. Function | Description ---|--- **Close editor** | Closes the selected editor tab. **Close view** | Closes the selected view panel. **Create new connection** | Opens the [New Connection](../Create-Connection/) wizard. **Open database object editor** | Opens an editor for a supported database object. **Open SQL Editor** | Opens a new SQL Editor tab. **Open view** | Opens a specific view by its identifier. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-Functions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * AI functions [ AI functions ](./) Table of contents * Supported providers * Enable AI functions * Available functions * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported providers * Enable AI functions * Available functions 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. AI functions # AI functions ![tag-outline](/docs/includes/icons/tag-outline.svg)Since 25.3 This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. AI functions extend what the [AI Assistant](../AI-Smart-Assistance/) can do inside DBeaver. With them, the assistant can export or compare data, read sample rows for context, or open and manage views and editors just like you would through the UI. Info Functions work in [AI chat](../AI-chat/) and through the [ai command](../AI- command/). AI functions never run actions silently. Each operation opens the corresponding wizard or view, so you stay in charge at every step. By default, all functions are turned off. To use them, enable the checkboxes for the functions you need in the [AI settings](../AI-Assistance-settings/#functions). ## Supported providers¶ AI functions are available only with providers that support function calling (tools): * [OpenAI](../AI-integration-with-OpenAI/) * [Google Gemini](../AI-integration-with-Google-Gemini/) * [Anthropic Claude](../AI-integration-with-Anthropic-Claude/) * [Ollama](../AI-integration-with-Ollama/) Info If your provider doesn’t support function calling, AI Assistant will continue to respond with text or SQL suggestions as usual. Make sure the model you select supports tool calling. ## Enable AI functions¶ Before adjusting functions, make sure AI Assistant is enabled. For setup steps, see [AI Assistant settings](../AI-Assistance-settings/#ai-assistant- setup). 1. Open **Window - > Preferences -> General -> AI -> Functions** 2. Expand a category to see the available functions 3. Select or clear the checkboxes to control what AI can access. Info For detailed descriptions of each setting, see [Functions settings](../AI- Assistance-settings/#functions). ![](../images/ai/ai-functions-settings.png) Note If a functions isn’t enabled, the assistant falls back to a normal chat response. ### Available functions¶ AI functions are organized by category. Category | Description ---|--- [Data transfer actions](../Data-Transfer-Actions/) | Import, export, and compare data or schemas using DBeaver’s transfer wizards. [Advanced metadata read actions](../Advanced-Metadata-Read-Actions/) | Read sample data or metadata for improved context and more accurate suggestions. [View and editor actions](../View-and-Editor-Actions/) | Open, close, or manage editors, views, and connections in the workspace. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-Smart-Assistance/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * AI Assistant [ AI Assistant ](./) Table of contents * Supported providers * AI Assistant features * Chat * Use functions * Work with SQL * Work with objects * Assist data transfer * Best practices for prompt formulation * Disable AI Assistant * Data privacy * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported providers * AI Assistant features * Chat * Use functions * Work with SQL * Work with objects * Assist data transfer * Best practices for prompt formulation * Disable AI Assistant * Data privacy 1. [DBeaver](/docs/dbeaver) 2. AI # AI Assistant Note If you're using DBeaver Community, see the [setup guide in GitHub Wiki](https://github.com/dbeaver/dbeaver/wiki/AI-Smart-Assistance-in-DBeaver- Community). AI support in Community is limited compared to Lite, Enterprise and Ultimate editions. DBeaver provides AI powered features for working with databases in natural language, using popular providers. It can [create and edit queries](../AI- query-suggestion/), [answer questions](../AI-chat/), [troubleshoot errors](../AI-error-explanation/), or [explore database objects](../AI-smart- metadata-description/). ## Supported providers¶ AI Assistant in DBeaver works with several AI providers. * [OpenAI](../AI-integration-with-OpenAI/) * [GitHub Copilot](../AI-integration-with-GitHub-Copilot/) * [Azure OpenAI](../AI-integration-with-Azure-OpenAI/) * [Google Gemini](../AI-integration-with-Google-Gemini/) * [Ollama](../AI-integration-with-Ollama/) * [Anthropic Claude](../AI-integration-with-Anthropic-Claude/) * [Amazon Bedrock](../AI-integration-with-Amazon-Bedrock/) DBeaver isn’t affiliated with these providers. Integration with AI assistance is achieved through the public APIs. To use AI Assistant, sign up with a provider and [activate it](../AI-Assistance-settings/#ai-assistant- setup) in DBeaver. Important Some paid AI provider plans don’t allow access for use in third-party applications. Make sure your subscription includes this capability before connecting. ## AI Assistant features¶ ### Chat¶ * [AI Chat](../AI-chat/). Chat naturally with AI to ask questions and get queries. * [Speech recognition](../AI-speech-recognition/). Convert spoken input into text and use it to generate SQL queries. ### Use functions¶ * [AI Functions](../AI-Functions/). Let AI open tools, launch wizards, and perform guided actions inside DBeaver. ### Work with SQL¶ * [Query suggestion](../AI-query-suggestion/). See SQL suggestions as you type in the SQL Editor. * [Explain query](../AI-query-explanation/). Run AI to explain what a query does in plain language. * [Fix SQL errors](../AI-error-explanation/). See what went wrong and how to fix a failed query. * [AI command](../AI-command/). Run AI command directly in the SQL Editor. Type command like `@ai show films in which Grace Mostel starred`, and let AI generate the SQL for you. ### Work with objects¶ * [Describe object with AI](../AI-smart-metadata-description/). Let AI describe the purpose of a table, view, or other object. ### Assist data transfer¶ * [Map with AI](../Data-migration/#mapping-rules). Automatically map source tables and columns to target names and types. AI analyzes sample data and schema structure, then suggests mappings. ### Best practices for prompt formulation¶ Follow these guidelines to get the most accurate results from AI: * **Use English** : While AI supports multiple languages, English works best. * **Know your database** : The more you understand your database structure, the more accurate the generated queries. * **Refine iteratively** : Start broad, then add details step by step to improve results. * **Be explicit** : Mention specific tables or columns if you know them - this helps AI generate precise queries. ## Disable AI Assistant¶ Learn more about [disabling AI Assistant](../Disable-AI-assistance/). ## Data privacy¶ DBeaver protect your data and privacy with strict safeguards. AI Assistant works with the minimum information required, and all processing follows provider privacy policies. Info Learn more in [Data privacy](../AI-Assistance-and-Data-Privacy/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-chat/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * AI chat [ AI chat ](./) Table of contents * Using AI Chat * AI Chat configuration * Connection field * Multiple conversations * Resetting query context * Defining the scope * AI Chat settings * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Using AI Chat * AI Chat configuration * Connection field * Multiple conversations * Resetting query context * Defining the scope * AI Chat settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. AI chat # AI chat Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver provides AI Chat for working with databases in natural language. You can enter requests in plain text to generate SQL queries, get explanations, or ask questions about your databases. ## Using AI Chat¶ To use the **AI Chat** : 1. Click on the **AI Chat** icon ![](../images/ai/ai-smart-completion-button.png) located in the DBeaver [toolbar](../Application-Window-Overview/#toolbar). ![](../images/ai/ai-in-toolbar.png) * Alternatively, open the [SQL Editor](../SQL-Editor/) and click on the **AI Assistant** icon ![](../images/ai/ai-smart-completion-button.png) located in the left toolbar. Note The toolbar is customizable. For further information, refer to [Toolbar Customization](../Toolbar-Customization/) article. 2. In the chat window that opens, select a connection and, optionally, a scope. 3. Enter your request in natural language. 4. Press the **Send** button to get the SQL translation. You can then choose from the following options: * **Execute** to run the generated SQL query * **Editor** to open the query in the SQL Editor and continue working with it directly Tip If the cursor is on a query, clicking **Editor** will replace it. Move to a new line to keep the old query. * **Copy** to copy the query to your clipboard ![](../images/ai/ai-chat-demo.png) ### AI Chat configuration¶ #### Connection field¶ To use a specific connection in **AI Chat** , select the connection from the toolbar at the top of the chat panel. The selected connection defines which database the AI will use when generating SQL queries. ![](../images/ai/ai-connection-field.png) #### Multiple conversations¶ You can create multiple chats for different connections. ![](../images/ai/ai-multiple-conversations.png) The first chat is created automatically when you open **AI Chat**. Each chat is named based on your first prompt. Messages related to the same query or object in the same connection are kept together in one conversation. Action | Button/icon | How to do it ---|---|--- Add a new chat | ![](../images/ug/tasks/add-task-button.png) | Click the button to start a new conversation Switch chats | _(Dropdown menu)_ | Use the dropdown menu to switch between existing chats Delete a chat | ![](../images/ug/Delete-DB-object.png) | Select the chat from the dropdown, then click the delete button Important Deleted conversations can’t be restored. #### Resetting query context¶ AI Chat keeps the history of your questions so you can build on them. Sometimes you may want to start fresh. To reset the context or clear history up to a certain message, click the reset button (![](../images/ug/Clear- columns-button.png)) next to that message. Example You asked about the “orders” table and then want to switch to “customers”. Reset before your new question so AI doesn’t mix both topics. #### Defining the scope¶ To improve accuracy, especially in databases with large schemas, you can use the **Scope** field to limit the context to specific database objects. 1. In the **AI Chat** toolbar, click the **Change scope** button ![](../images/ai/change-scope-button.png) to open the context menu. 2. Choose the desired context level: Scope option | Description ---|--- **Current schema** | AI focuses only on the schema you’re currently using **Current database** | AI is limited to the currently selected database **This connection** | AI considers all schemas within the current database connection **This conversation** | AI uses only the context and metadata gathered in the current chat **All objects** | AI can access metadata for all available connections, databases, and schemas **Custom** | Lets you define a more specific scope, such as a particular table or set of objects ### AI Chat settings¶ You can adjust a few key options to make **AI Chat** work the way you prefer. Go to **Window - > Preferences -> General -> AI -> AI Chat**. Setting | Description ---|--- **Send previous answers** | Passes earlier replies back to the AI to improve context, but uses more tokens **Days to keep chats** | Sets how long your chat history is stored locally **Use experimental renderer** | Switches to a faster web-based view of AI Chat (still in development) Tip See the full list of [AI settings](../AI-Assistance-settings/#ai- configuration). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-command/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * AI command [ AI command ](./) Table of contents * Using AI command * Control AI query execution * Preview and confirm AI command queries * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Using AI command * Control AI query execution * Preview and confirm AI command queries 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. Work with SQL # AI command Note If you're using DBeaver Community, see the [setup guide in GitHub Wiki](https://github.com/dbeaver/dbeaver/wiki/AI-Assistance-in-DBeaver- Community#ai-command). The AI command lets you run natural language requests directly in the SQL Editor. Just type `@ai` with your question, and DBeaver will generate and execute the SQL for you. ## Using AI command¶ To use the **AI command** : 1. Open the [SQL Editor](../SQL-Editor/). 2. Type your request using the `@ai` command. Example `@ai show all customers with invoices in the last month` 3. Execute the AI command. The results will appear in the [Result](../SQL-Editor/#results-panel) panel. AI commands can execute queries directly against the database. To control how this happens, configure the AI query execution settings. ## Control AI query execution¶ By default, `SELECT` queries execute immediately, while modification and schema changes require confirmation. You can adjust this behavior in **Window - > Preferences -> General -> AI -> AI configuration -> [AI query execution](../AI-Assistance-settings/#ai-query- execution)**. ### Preview and confirm AI command queries¶ If confirmation is enabled, running an `@ai` command opens a dialog before execution. ![](../images/ai/ai-command-confirmation.png) **How it works** : 1. When you run the `@ai ...` command, the dialog shows a warning about the type of query (for example, schema modification). 2. In the confirmation dialog, click **Show Query** to review the generated SQL. 3. If the query looks correct, click **Yes** to execute. Otherwise, click **No** to cancel and adjust your request. Warning If confirmations are disabled and autocommit is on, AI commands can change data immediately. Enable **Show confirmation** for modify and schema queries, or use **Disable autocommit** to stay safe. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-error-explanation/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * Fix SQL errors [ Fix SQL errors ](./) Table of contents * Using AI error explanation * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Using AI error explanation 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. Work with SQL # Fix SQL errors Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. AI error explanation helps you understand and fix SQL errors using AI. ## Using AI error explanation¶ 1. After running a query, if an error occurs, the **Explain and Fix** button appears below the error message in the Results panel. ![](../images/ai/ai-explain-and-fix.png) 2. Click it to open [AI Chat](../AI-chat/) with an explanation and a suggested fix. ![](../images/ai/ai-chat-explain-error.png) 3. Use **Execute** to apply the fixed query. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-integration-with-Amazon-Bedrock/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * Amazon Bedrock [ Amazon Bedrock ](./) Table of contents * Engine settings * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Engine settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Settings](/docs/dbeaver/AI-Assistance-settings) 4. Providers # Amazon Bedrock ![tag-outline](/docs/includes/icons/tag-outline.svg)Since 25.3 This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To use Amazon Bedrock as an AI provider in DBeaver, set it up like this: 1. As an administrator, open the [AWS console](https://console.aws.amazon.com/) and go to IAM (Identity and Access Management) 2. Create or use an IAM user/account that has permissions to use Bedrock, and generate an Access Key ID and Secret Access Key for this user 3. In DBeaver, open **Engine settings** 4. Enter the **Access key** and **Secret key** 5. Select your **Region** 6. Choose a model from the **Model/Inference** list 7. Click **Test connection** to verify that the key and model work correctly 8. Apply the changes ## Engine settings¶ Setting | Description | default ---|---|--- **Access key** | Your AWS access key with permissions to call Amazon Bedrock. | **Secret key** | Your AWS secret key. | **Region** | AWS region where Bedrock is enabled for your account, such as `us-east-1` or `eu-central-1`. | **Model/Inference** | Choose the AI model. Use Load model list to refresh the available models. You can also type a model name manually. | **Show available inferences** | Fetches and displays the models available to your AWS account in the selected region. | false **Context size** | A larger number allows the AI to use more data for better answers but may slow down response time. | `20000` **Temperature** | Control AI's creativity from `0.0` (more precise) to `0.9` (more diverse). Note that higher temperature can lead to less predictable results. | `0.0` **Write AWS Bedrock queries to debug log** | Logs your AI requests. For more details on logging, see [Log Viewer](../Log-files/). | false Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-integration-with-Anthropic-Claude/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * Anthropic Claude [ Anthropic Claude ](./) Table of contents * Engine settings * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Engine settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Settings](/docs/dbeaver/AI-Assistance-settings) 4. Providers # Anthropic Claude Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To use Claude as an AI provider in DBeaver, configure it as follows: 1. As an administrator, sign up on the [Anthropic Console](https://console.anthropic.com/) 2. Navigate to the [Dashboard](https://console.anthropic.com/dashboard) and generate a new API key 3. In DBeaver, go to Engine Settings and insert this key into the **API token** field 4. Choose the desired model 5. Click **Test connection** to verify that the key and model work correctly 6. Apply the changes ## Engine settings¶ Setting | Description | Default ---|---|--- **API token** | Input your secret key from the provider platform. You can create it in the [Anthropic console](https://console.anthropic.com/dashboard). | **Model** | Choose the AI model. Models are loaded dynamically and can be refreshed using the **Refresh models** button next to the field. | `claude-opus-4-1-20250805` **Context window size** | A larger number allows the AI to use more data for better answers but may slow down response time. By default, it’s set dynamically if model provides. | **Temperature** | Control AI's creativity from `0.0` (more precise) to `0.9` (more diverse). Note that higher temperature can lead to less predictable results. | `0.0` **Write AI queries to debug log** | Logs your AI requests. For more details on logging, see [Log Viewer](../Log-files/). | disabled Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-integration-with-Azure-OpenAI/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * Azure OpenAI [ Azure OpenAI ](./) Table of contents * Engine settings * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Engine settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Settings](/docs/dbeaver/AI-Assistance-settings) 4. Providers # Azure OpenAI Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To use Azure OpenAI as an AI provider in DBeaver, configure it as follows: 1. Sign in to the [Azure Portal](https://portal.azure.com/) 2. Click **Create a resource** in the menu 3. Open the **AI Apps and Agents** category 4. Select **Azure OpenAI** from the list and click **Create** 5. Generate and copy the credentials for the newly created service 6. Insert these credentials into DBeaver's Engine Settings 7. Apply the changes ## Engine settings¶ Setting | Description | Default ---|---|--- **API token** | Input your secret key from the provider platform (generate it in the [Azure portal](https://learn.microsoft.com/azure/ai-services/openai/how-to/create-resource)). | **Endpoint** | Configure a custom endpoint URL for Azure OpenAI (for example, `https://.openai.azure.com/`). For details, see [Azure OpenAI endpoints](https://learn.microsoft.com/en-us/azure/ai-foundry/foundry-models/concepts/endpoints?tabs=python). | **Deployment** | Specify the deployment name you assigned when deploying a model in Azure. This is required because Azure identifies models by deployment name, not by raw model ID. | **Audio Deployment** (Optional) | Specify the deployment name used for audio transcription (speech-to-text). | **Context window size** | A larger number allows the AI to use more data for better answers but may slow down response time. | **Temperature** | Control AI's creativity from `0.0` (more precise) to `0.9` (more diverse). Note that higher temperature can lead to less predictable results. | `0.0` **Write AI queries to debug log** | Logs your AI requests. For more details on logging, see [Log Viewer](../Log-files/). | disabled Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-integration-with-GitHub-Copilot/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * GitHub Copilot [ GitHub Copilot ](./) Table of contents * Engine settings * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Engine settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Settings](/docs/dbeaver/AI-Assistance-settings) 4. Providers # GitHub Copilot Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To use GitHub Copilot as an AI provider in DBeaver, configure it as follows: 1. Sign in to your [GitHub account](https://github.com/) 2. Go to the [GitHub Copilot page](https://github.com/features/copilot) and activate a free trial or subscription 3. In DBeaver, go to Engine settings and select **GitHub Copilot** 4. Click **Authorize** to get your OAuth code 5. Click **Copy and Open** \- this opens the GitHub authorization page 6. Paste the code, confirm access, and authorize the GitHub Copilot plugin 7. After completing the OAuth flow, the access token will be filled in automatically in DBeaver Important The token is visible only once. After you save the changes, it’ll be masked for security. 8. Choose the model 9. Click **Test connection** to verify that the key and model work correctly 10. Apply the changes ## Engine settings¶ Setting | Description | Default ---|---|--- **Access token** | Input your secret key from the provider platform. Can also be acquired by signing in via OAuth using the **Authorize** button. | **Model** | Choose the AI model. Models are loaded dynamically and can be refreshed using the **Refresh models** button next to the field. | **Context window size** | A larger number allows the AI to use more data for better answers but may slow down response time. Choose based on your balance of accuracy and speed. | **Temperature** | Control AI's creativity from `0.0` (more precise) to `0.9` (more diverse). Note that higher temperature can lead to less predictable results. | `0.0` **Write AI queries to debug log** | Logs your AI requests. For more details on logging, see [Log Viewer](../Log-files/). | disabled Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-integration-with-Google-Gemini/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * Google Gemini [ Google Gemini ](./) Table of contents * Engine settings * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Engine settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Settings](/docs/dbeaver/AI-Assistance-settings) 4. Providers # Google Gemini Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To use Google Gemini as an AI provider in DBeaver, configure it as follows: 1. Sign up on the [Google Cloud Platform](https://cloud.google.com/). 2. Navigate to the [Google Cloud Console](https://console.cloud.google.com/) and create a new project. 3. Enable the Gemini API for your project by searching for the Gemini API in the marketplace and clicking **Enable**. 4. Create credentials for your project by navigating to the **Credentials** page under **APIs & Services**. Choose **Create credentials** and select the appropriate type for your Gemini integration. 5. Copy the generated credentials. 6. Insert these credentials into DBeaver's Engine Settings. 7. Click **Test connection** to verify that the token and model work correctly. 8. Apply the changes. Note Google Gemini services are subject to regional availability. Check the list of [available regions](https://ai.google.dev/available_regions) to ensure access in your area. ## Engine settings¶ Setting | Description | Default ---|---|--- **API token** | Input your secret key from the provider platform. You can create an API key in [Google MakerSuite](https://makersuite.google.com/app/apikey). | **Model** | Choose the AI model. Models are loaded dynamically and can be refreshed using the **Refresh models** button next to the field. You can also type a model name manually. | **Temperature** | Control AI's creativity from `0.0` (more precise) to `0.9` (more diverse). Note that higher temperature can lead to less predictable results. | `0.0` **Write Gemini queries to debug log** | Logs your AI requests. For more details on logging, see [Log Viewer](../Log-files/). | disabled Tip If you use Gemini with a model that supports tool calling, [AI functions](../AI-Functions/) are available. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-integration-with-Ollama/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * Ollama [ Ollama ](./) Table of contents * Engine settings * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Engine settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Settings](/docs/dbeaver/AI-Assistance-settings) 4. Providers # Ollama Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To use Ollama as an AI provider in DBeaver, configure it as follows: Ensure that [Ollama](https://ollama.com/) is already installed and running on a server. For installation instructions, see the [Ollama docs](https://github.com/ollama/ollama). You will need the host address where Ollama is installed to proceed. 1. Specify the host address of your Ollama server in the **Instance host** field, ensuring it follows the format `http://host:port` 2. Click **Load Models**. If the host address is correct, DBeaver will display the available models from your Ollama server in the **Model** dropdown menu 3. Select the model you need for your integration 4. Apply the changes ## Engine settings¶ Setting | Description | Default ---|---|--- **Instance host** | Specify the address of the Ollama server in the format `http://host:port`. This is required for connecting and loading available models. | http://localhost:11434 **Model** | Choose the AI model. | **Refresh models** | Re-reads the list of all enabled models from the provider. | **Context size** | Choose the context size between `2048` and `32768`. A larger number allows the AI to use more data for better answers but may slow down response time. Choose based on your balance of accuracy and speed. | `3000` **Temperature** | Control AI's creativity from `0.0` (more precise) to `0.9` (more diverse). Note that higher temperature can lead to less predictable results. | `0.0` **Write Ollama queries to debug log** | Logs your AI requests. For more details on logging, see [Log Viewer](../Log-files/). | disabled Tip If you use Ollama with a model that supports tool calling, [AI functions](../AI-Functions/) are available. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-integration-with-OpenAI/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * OpenAI [ OpenAI ](./) Table of contents * Engine settings * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Engine settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Settings](/docs/dbeaver/AI-Assistance-settings) 4. Providers # OpenAI To use OpenAI as an AI provider in DBeaver, configure it as follows: 1. Sign up on the [OpenAI platform](https://openai.com/api/) 2. Navigate to the [API Keys section](https://platform.openai.com/account/api-keys) and generate a new secret key 3. In DBeaver, go to Engine settings and insert this key into **API token** field 4. Choose the model 5. Click **Test connection** to verify that the key and model work correctly 6. Apply the changes Note OpenAI services are available in specific countries. Consult the [supported countries](https://platform.openai.com/docs/supported-countries) list to verify availability in your location. ## Engine settings¶ Setting | Description | Default ---|---|--- **API token** | Input your secret key from the provider platform. | **Model** | Choose the AI model. Models are loaded dynamically and can be refreshed using the **Refresh models** button next to the field. You can also type a model name manually. | `gpt-4o` **Context window size** | A larger number allows the AI to use more data for better answers but may slow down response time. By default, the size is set dynamically based on the selected model (if the model provides this information). | `128000` **Temperature** | Control AI's creativity from `0.0` (more precise) to `0.9` (more diverse). Note that higher temperature can lead to less predictable results. | `0.0` **Transcript model** | Choose the AI model for speech-to-text transcription. For details, see [AI speech recognition](../AI-speech-recognition/). Models are loaded dynamically and can be refreshed using the **Refresh models** button next to the field. You can also type a model name manually. | `whisper-1` **API base URL** | The address where requests to the AI service are sent (for example, `https://api.openai.com/v1/`). Normally this is filled automatically for the selected provider. Change it only if you use a custom endpoint. | https://api.openai.com/v1/ **Use legacy API** | Use the legacy OpenAI chat API (`/v1/chat/completions`). May be useful if you’re using an OpenAI-compatible engine that doesn’t support the newer `/v1/responses` endpoint. | disabled **Write AI queries to debug log** | Logs your AI requests. For more details on logging, see [Log Viewer](../Log-files/). | disabled Tip If you use OpenAI with a model that supports tool calling, [AI functions](../AI-Functions/) are available. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-query-explanation/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * Explain query [ Explain query ](./) Table of contents * Using Explain Query using AI * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Using Explain Query using AI 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. Work with SQL # Explain query Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. You can use **Explain Query using AI** to quickly understand what your SQL query does. The LLM translates your SQL into plain language, helps you catch mistakes, and makes it easier to understand complex logic. ## Using Explain Query using AI¶ To use it: 1. Open your query in the [SQL Editor](../SQL-Editor/). 2. Select the needed query text. 3. Right-click and choose **AI commands - > Explain Query using AI**. ![](../images/ai/explain-query-using-ai.png) 4. In the [AI chat](../AI-chat/) window that opens you will see an explanation of the selected query. You can continue the conversation, ask follow-up questions, and iterate on the query with help from the LLM. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-query-suggestion/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * Query suggestion [ Query suggestion ](./) Table of contents * Using AI query suggestion * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Using AI query suggestion 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. Work with SQL # Query suggestion Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. AI query suggestion helps you finish entire SQL statements based on what you’ve started typing. It works inside the [SQL Editor](../SQL-Editor/) and shows suggestions as ghost text. ## Using AI query suggestion¶ 1. Enable AI query suggestion in the [SQL Competition](../AI-Assistance-settings/#sql-completion) preferences. 2. Start writing a query in the SQL Editor. 3. Add a comment above the query to guide the AI. Example -- find flight with flight_id equal or less then 1230 SELECT **Note** : You need to place your cursor where you want the query to appear. 4. Right-click anywhere in the **Script panel** to open the context menu, then select **AI commands - > Show AI Suggestion Text**. Or use the shortcut: * `⌥+⌘+→` (macOS). * `Alt+Ctrl+→` (Windows). ![](../images/ai/ai-query-suggestion.png) 5. Do one of the following: * Press `→`, `Tab`, or `Enter` to insert the suggestion. * Press `Esc` to dismiss it. Tip To change the background and foreground colors of the suggestion hint, navigate to **Window - > Preferences -> User Interface -> Appearance -> Colors and Fonts**. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-smart-metadata-description/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * Describe object with AI [ Describe object with AI ](./) Table of contents * Describe an object * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Describe an object 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. Work with objects # Describe object with AI Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. The **Describe Database Object** command helps you quickly understand the purpose of a table, view, or another object. It uses AI to generate a short, human-readable description based on object metadata. ## Describe an object¶ To use the Metadata description: 1. Open the [Database Navigator](../Database-Navigator/) or [Properties Editor](../Properties-Editor/). 2. Right-click a supported object: * Schemas * Tables * Views * Indexes * Triggers * Procedures 3. Select **Describe database object** from the context menu. ![](../images/ai/tutorial/quickstart-describe-object.png) 4. In the [AI chat](../AI-chat/) window that opens you will see a short description. You can continue the conversation, ask follow-up questions, and iterate on the query with help from the LLM. ![](../images/ai/ai-describe-db-object.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AI-speech-recognition/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * Speech recognition [ Speech recognition ](./) Table of contents * Using AI speech recognition * AI speech recognition settings * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Using AI speech recognition * AI speech recognition settings 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. AI chat # Speech recognition ![tag-outline](/docs/includes/icons/tag-outline.svg)Since 25.2 This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver provides speech recognition in AI Chat. This feature lets you convert spoken input into text, which can then be used to generate SQL queries or ask questions about your databases. ## Using AI speech recognition¶ To use the **AI speech recognition** : 1. Click on the **AI Chat** icon ![](../images/ai/ai-smart-completion-button.png) located in the DBeaver [toolbar](../Application-Window-Overview/#toolbar). * Alternatively, open the [SQL Editor](../SQL-Editor/) and click on the **AI Assistant** icon ![](../images/ai/ai-smart-completion-button.png) located in the left toolbar. Note The toolbar is customizable. For further information, refer to [Toolbar Customization](../Toolbar-Customization/) article. 2. In the chat window, click the Microphone button (![](../images/ai/ai-speech-recognition-button.png)) to start speech recognition, speak your request, and wait for it to be transcribed into text. You can edit the text before sending it. 3. Press the **Send** button to get the SQL translation, then choose one of the following options: * **Execute** to run the generated SQL query * **Editor** to open the query in the SQL Editor and continue working with it directly * **Copy** to copy the query to your clipboard and paste it wherever you need ![](../images/ai/ai-chat-demo.png) ### AI speech recognition settings¶ You can fine-tune how speech recognition works in **AI Chat**. Go to **Window - > Preferences -> General -> AI**. Setting | Description ---|--- **Transcript model** | Selects the AI model used for converting speech to text **Language** | Sets the language for recognition and responses Tip See the full list of [AI settings](../AI-Assistance-settings/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-Cloud-Explorer/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * AWS cloud explorer [ AWS cloud explorer ](./) Table of contents * Requirements for AWS connection * Setting up AWS permissions * Connection setup * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Requirements for AWS connection * Setting up AWS permissions * Connection setup 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. Cloud explorer # AWS cloud explorer Note This feature is available in [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver facilitates advanced functionalities for efficiently managing and connecting to Amazon Web Services (AWS) databases through its user interface. The process for setting up and altering connections is detailed in the [Cloud Explorer article](../Cloud-Explorer/). This article outlines the key steps and prerequisites for connecting to an AWS database using DBeaver. ## Requirements for AWS connection¶ Before initiating a connection to an AWS database using Cloud Explorer, ensure that you meet the following pre-requisites: * **Existing AWS account** : An active AWS account is required. Ensure it is [properly configured](https://docs.aws.amazon.com/pdfs/SetUp/latest/UserGuide/setup-guide.pdf) following the setup guide provided by AWS. If you do not have an account, sign up at the [Amazon website](https://aws.amazon.com/). * **Security credentials** : Ensure you have at least one of the following security credentials for your AWS account: * **AWS Access/Secret keys**. * **Default credentials**. * **AWS profile**. ### Setting up AWS permissions¶ Before you initiate a connection, ensure your AWS account is configured with the correct roles and permissions. * **IAM User Permissions** : Your IAM (Identity and Access Management) user needs to have policies attached that grant the necessary permissions for accessing the database. * **Role Assignment** : In case you are assuming a role for database access, ensure that the role has the required permissions. * **Security Group Configuration** : The security group associated with your database instance should be configured to allow inbound traffic from your IP address on the database port. For detailed instructions on roles and permissions setup, consult the official [AWS roles guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). ## Connection setup¶ 1. Click on the Cloud Explorer button ![](../images/ug/cloud-explorer/cloud-explorer-button.png) or navigate to **Database** -> **Cloud Explorer** in the menu. 2. Navigate to the Amazon Web Services section. ![](../images/ug/cloud-explorer/aws-cloud-configuration.png) 3. Select one of the available authentication methods in DBeaver. Tip For detailed information about the authentication methods supported by DBeaver for AWS connections, see the [Cloud Explorer documentation](../Cloud- Explorer/#amazon-web-services). If your connection requires SSH, fill in the necessary credentials in the [**Tunnels**](../SSH-Configuration/) tab. 4. Verify the correctness of your credentials by clicking on the **Test Connection** button. Then click on **Apply and Close** to save your settings and close the settings window. 5. After completing the steps, the **AWS configuration** will appear in your configuration list. 6. Select the desired database from the drop-down menu to connect via DBeaver. ![](../images/ug/cloud-explorer/aws-cloud-services.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-Credentials/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * AWS credentials [ AWS credentials ](./) Table of contents * Settings * Credentials * Default credentials * Access keys * AWS Profiles * SSO * AWS Secrets Manager * Secure Storage with Secret Providers * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Settings * Credentials * Default credentials * Access keys * AWS Profiles * SSO * AWS Secrets Manager * Secure Storage with Secret Providers 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. [Cloud connection settings](/docs/dbeaver/AWS-Permissions) 4. AWS # AWS credentials Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver is integrated with AWS RDS IAM authentication, providing you with the ability to authenticate in AWS to access your cloud databases. There are numerous ways to authorize and authenticate users in DBeaver AWS IAM, and DBeaver supports all the basic ones. The instructions provided here are intended for the client machine where DBeaver is installed. It is assumed that the necessary configuration on the server side, including the setup of AWS RDS IAM, has already been completed. ![](../images/auth_methods/AWS_RDS_IAM/aws-rds-authentication- configuration.png) ## Settings¶ To use IAM authentication in DBeaver, you need to select **AWS RDS IAM** as your authentication method in the connection settings. Setting | Description ---|--- **Credentials** | Choose between Access/secret keys, AWS profile, or Default credentials for the type of IAM credentials configuration. **User** | Input your username. **Region** | Optional field to specify the AWS region. If not specified, the global region will be used. **Access key** | AWS Access key. **Secret key** | AWS Secret key. **Role name** | Input the name of the role you want to use. **Save credentials locally** | Check this box if you want to save your password locally. **3rd party account** | Check this box if you want to access using a 3rd party role-based account. **Use AWS Secrets Manager** | Check this box if you want to connect to AWS Secrets Manager to access the database credentials. When selected, a field **Secret Name** will appear where you can input the name of your **AWS Secret**. Tip DBeaver also supports AWS Systems Manager (SSM) for accessing databases. For detailed instructions on setting up AWS SSM, refer to the [AWS SSM setup guide](../AWS-SSM-Configuration/). ## Credentials¶ Choose the type of credentials by selecting the appropriate option from the **Credentials** dropdown menu. ### Default credentials¶ When you use Default Credentials, AWS will then try to determine credentials by using the standard credential providers chain: 1. Java system properties 2. Environment variables 3. Web identity token from AWS STS 4. The shared credentials and config files 5. Amazon ECS container credentials 6. Amazon EC2 instance profile credentials 7. Amazon SSO credentials Using default credentials is the easiest way to integrate with various Single Sign-On (SSO) and web identity providers, as these providers typically supply credentials through configuration files. For a more detailed explanation, please refer to the [AWS credentials documentation](https://docs.aws.amazon.com/sdk-for-java/latest/developer- guide/credentials.html). To use Default credentials, simply enter your username in the **User** field and select your AWS region. ### Access keys¶ Using the IAM user access key and secret key is the simplest way to authenticate. You just need to input these two keys. You have the option to save them locally for convenience, or, for better security, you can choose to enter them each time you connect to a database. As with the Default configuration, you need to enter your username and select the AWS region. If you've checked the **Save credentials locally** box, you'll need to fill in the **Access key** and **Secret key** fields. If you haven't checked this box, you'll be prompted to fill in these fields each time you connect to the database. For more detailed instructions on managing access keys for IAM users, you can refer to the [official AWS guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access- keys.html). ### AWS Profiles¶ Just like with default credentials, you also have the option to select a specific credentials profile. To do this, first select the profile you've already configured. If you need information on how to configure a profile, you can find it below. After selecting a profile, fill in the **User** field and select your AWS region, just like you would with the default credentials. For more detailed instructions, you can refer to the official AWS guide on [credentials config files](https://docs.aws.amazon.com/sdkref/latest/guide/creds-config- files.html). ### SSO¶ If you've set up an [SSO](../AWS-SSO/) portal on your AWS account, you can use it for web-based SSO authorization. This SSO support can be activated for both Default and Profile-based AWS authorization types. To use this feature, you need to enable the **Enable SSO** option. ## AWS Secrets Manager¶ If you've set up an **AWS Secret** , you can use it to access your database. This method can be used for both RDS databases and Redshift. You can find instructions on how to create an **AWS Secret** in [official guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/). Remember, you'll need to fill in the **Password** field. To use this feature, check the **Use AWS Secrets Manager** box and then fill in the **Secret Name** field. Note Make sure that the secret in the same region as the database. ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-DocumentDB/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * DocumentDB [ DocumentDB ](./) Table of contents * Connections * Queries * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Connections * Queries 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # DocumentDB Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. AWS DocumentDB is based on the [MongoDB](../MongoDB/) engine. It has several minor differences in the query processing and network configuration. However, most features which work for MongoDB will work for DocumentDB as well. Please refer to the [MongoDB](../MongoDB/) article. ## Connections¶ AWS restricts direct access to DocumentDB clusters from outside of the cloud (region). So you can connect to it directly (using a cluster host name) only when DBeaver is deployed on the EC2 instance. In other cases you will need to use the SSH tunnel through a proxy machine to access DocumentDB instance. Please read the AWS Documentation about proxy configurations: https://docs.aws.amazon.com/documentdb/latest/developerguide/connect-from- outside-a-vpc.html In DBeaver you can use the SSH tab on the connection settings page. Just enter proxy host, user name and specify a private key file (it is provided by AWS as a keypair). ## Queries¶ DBeaver processes DocDB SQL queries exactly like in [MongoDB](../MongoDB/). It supports SELECT, UPDATE, INSERT and DELETE queries. SELECT queries support WHERE, ORDER BY, GROUP BY and HAVING clauses. DocumentDB restricts the `eval` function so all JavaScript queries will be parsed on the client's side and then evaluated at a DocDB cluster one by one. Most JS functions work exactly like in Mongo Shell. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-DynamoDB/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * DynamoDB [ DynamoDB ](./) Table of contents * Supported features * DynamoDB connection * Database navigation * Viewing table data * Viewing data in JSON document format * Executing queries * Exporting and importing data * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported features * DynamoDB connection * Database navigation * Viewing table data * Viewing data in JSON document format * Executing queries * Exporting and importing data 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # DynamoDB Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. **Warning** : This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per-request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable- metadata-queries). ## Supported features¶ * Table data view * Table data edit in document (json) mode * Data filters * SQL queries execution * JSON queries execution * Data export and import ## DynamoDB connection¶ ![](../images/database/dynamodb/connection-page.png) DBeaver supports AWS Cloud and Standalone versions of DynamoDB. For standalone server you need to enter endpoint (http or https URL). For cloud server you must enter the AWS region. DynamoDB exists in all available regions in your AWS account but the tables are different. AWS Access Key and Secret Key are used for authentication. For 3rd-party account access you must specify the 3rd party account ID (12-digits number) and the 3rd party role name. This role will be used for permission management. You account must be added to the whitelist in the 3rd party account. Press "Test Connection" to validate your connection settings. ## Database navigation¶ DynamoDB has a simple metadata structure. Basically, you can only access Table and Global tables. Table has primary attributes (a kind of primary key) and indexes. DynamoDB is a document-oriented database. Each table may have its own set of attributes and sub-attributes. ![](../images/database/dynamodb/database-structure.png) ## Viewing table data¶ You can open table editor and see the table data. You may need to switch to the "Data" tab. DBeaver converts DynamoDB documents into a table format by default, but you can switch to another data representation. You can use data filters in order to find documents. ![](../images/database/dynamodb/data- view.png) ## Viewing data in JSON document format¶ You view, search and edit JSON documents. Double-click on a document to activate the editor. ![](../images/database/dynamodb/data-view-json.png) ## Executing queries¶ DBeaver supports simple SQL dialect for DynamoDB. You can use the WHERE clause in the same fashion as in regular SQL in order to find or filter documents. You can also use JSON requests syntax to query documents. See [Amazon DynamoDB query reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html). ![](../images/database/dynamodb/sql-query-simple.png) ## Exporting and importing data¶ You can export data from a DynamoDB table in different file formats (CSV, XLSX, XML, JSON, etc,) or export data directly to another table. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-Keyspaces/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * Keyspaces [ Keyspaces ](./) Table of contents * Connecting to Keyspaces * Browsing Keyspaces tables * Executing CQL * ERD * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Connecting to Keyspaces * Browsing Keyspaces tables * Executing CQL * ERD 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # Keyspaces Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. [AWS Keyspaces](https://docs.aws.amazon.com/keyspaces/latest/devguide/what-is- keyspaces.html) is a key-value database based on [Apache Cassandra](../Cassandra/). DBeaver supports the Keyspaces schema browser, data viewer and CQL queries execution. It also supports various administrative tools. Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ## Connecting to Keyspaces¶ AWS Keyspaces uses AWS IAM authentication. You need to specify your IAM credentials and AWS region. There is no specific endpoint - there is only one cluster per account per AWS region. There is also no need to configure SSH or SSL - DBeaver uses default AWS settings to access the Keyspace cluster. ![](../images/database/keyspaces/keyspaces-connection-init.png) ## Browsing Keyspaces tables¶ You can browse, view, edit and filter Cassandra tables the same way as with regular (relational) tables. However, being a distributed key-value database, Keyspaces does not support any kind of referential integrity. There are no foreign keys, references, etc. You should note that Cassandra has a very advanced (comparing to relational databases) data type system. Each column may be a collection, map, or set of values (with a very big number of values). In some cases this makes browsing data in the "Grid" mode inconvenient. ![](../images/database/cassandra/cassandra-schema.png) ![](../images/database/cassandra/cassandra-data-grid.png) ## Executing CQL¶ CQL [Cassandra Query Language](http://cassandra.apache.org/doc/4.0/cql/) is a very simple kind of SQL language dialect. It supports simple SELECT queries, DDL statements (like CREATE TABLE) and some other query types. You can use the standard DBeaver SQL editor to execute CQL queries. DBeaver supports Cassandra query execution, results scrolling, data export/import, mock data generation and other features. ## ERD¶ Physical ERD (Entity Relation Diagram) does not make much sense for Keyspaces as there are no foreign keys. However, you can make you own [custom ERD](../Custom-Diagrams/) and connect Keyspaces tables with each other using logical associations. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-Permissions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * AWS permissions [ AWS permissions ](./) Table of contents * Required permissions * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Required permissions 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. [Cloud connection settings](/docs/dbeaver/AWS-Permissions) 4. AWS # AWS permissions To use DBeaver with AWS, certain permissions are required for different actions. Below is a summary of the necessary permissions and their purposes. ## Required permissions¶ Service | Read Policy | Write Policy ---|---|--- Login | - | Cloud Explorer | - | S3 | [AmazonS3ReadOnlyAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonS3ReadOnlyAccess) | [AmazonS3FullAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonS3FullAccess) Redshift | [AmazonRedshiftReadOnlyAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonRedshiftReadOnlyAccess) | [AmazonRedshiftFullAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonRedshiftFullAccess) RDS | [AmazonRDSReadOnlyAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonRDSReadOnlyAccess) | [AmazonRDSFullAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonRDSFullAccess) DynamoDB | [AmazonDynamoDBReadOnlyAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonDynamoDBReadOnlyAccess) | [AmazonDynamoDBFullAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonDynamoDBFullAccess) DocumentDB | [AmazonDocDBReadOnlyAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonDocDBReadOnlyAccess) | [AmazonDocDBFullAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonDocDBFullAccess) Keyspaces | [AmazonKeyspacesReadOnlyAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonKeyspacesReadOnlyAccess) | [AmazonKeyspacesFullAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=eu-central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonKeyspacesFullAccess) Athena | "lakeformation:Describe _", "lakeformation:Get_", "lakeformation:List _", "sns:ListTopics", "sns:GetTopicAttributes", "s3:Describe_", "s3:Get _", "s3:List_", "s3:Put _", "glue:Get_", "glue:List _", "glue:BatchGet_", "athena:List _", "athena:Get_", "athena:Batch*", "athena:StartQueryExecution", "athena:StopQueryExecution" | [AmazonAthenaFullAccess](https://us- east-1.console.aws.amazon.com/iamv2/home?region=eu- central-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonAthenaFullAccess) Redis | [AmazonElastiCacheReadOnlyAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=us-east-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonElastiCacheReadOnlyAccess) | [AmazonElastiCacheFullAccess](https://us-east-1.console.aws.amazon.com/iamv2/home?region=us-east-1#/policies/details/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAmazonElastiCacheFullAccess) SSO | | Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-SSM-Configuration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * AWS SSM configuration [ AWS SSM configuration ](./) Table of contents * Configuring AWS CLI and Session Manager Plugin paths * Setting up AWS SSM * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configuring AWS CLI and Session Manager Plugin paths * Setting up AWS SSM 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. Connection network options # AWS SSM configuration Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. In some scenarios, you may need to interact with AWS resources through Systems Manager (SSM) to manage and automate operations. DBeaver offers a way to configure AWS SSM settings to facilitate this. Before proceeding, ensure that you have the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started- install.html) and [Session Manager Plugin for the AWS CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session- manager-working-with-install-plugin.html) installed on your local machine. ## Configuring AWS CLI and Session Manager Plugin paths¶ Before you can use AWS SSM with DBeaver, you need to specify the paths for the AWS CLI executable and the Session Manager Plugin. Follow these steps to configure the paths: 1. Navigate to **Window - > Preferences -> Connections -> AWS Configuration**. 2. You will see fields for the AWS CLI executable and the AWS SSM plugin path. ![](../images/ug/network/ssm/AWS-CLI-SSM-plugin-paths.png) 3. Enter the appropriate paths based on your operating system. **Path** | **Windows** | **MacOS/Unix** ---|---|--- **AWS CLI executable** | `C:\Program Files\Amazon\AWSCLI\bin\aws.exe` | `/usr/local/bin/aws` **AWS SSM plugin path** | `C:\Program Files\Amazon\SessionManagerPlugin\bin\session-manager-plugin.exe` | `/usr/local/bin/sessionmanagerplugin/bin` 4. After entering the paths, click the **Apply and Close** to apply the changes. ## Setting up AWS SSM¶ To configure AWS SSM, follow these steps: 1. Start [creating a new connection](../Create-Connection/). 2. Click on the plus (![](../images/plus-button.png)) button and select **AWS SSM**. ![](../images/ug/network/ssm/add-aws-ssm.png) 3. After selecting, an **AWS SSM** tab will appear in the menu at the top. ![](../images/ug/network/ssm/connection-aws-ssm.png) 4. In the **AWS SSM** tab, enter the necessary configuration details: Field | Description ---|--- **Instance ID** | Enter the ID of the EC2 instance you want to connect to. **Region** | Specify the AWS region where your EC2 instance is located. **Credentials** | Select the type of credentials you want to use. You can choose from `Default credentials`, `AWS profile`, or `Access/secret keys`. [Read more about AWS Credentials](../AWS-Credentials/) **Role Name** (Optional) | Enter the name or ARN of the AWS IAM role if you want to assume a role for this connection. **Enable SSO** | Check this box to enable Single Sign-On (SSO) authentication. [Learn more about AWS SSO](../AWS-SSO/) **3rd party account** | Check this box if you are using a third-party AWS account for this connection. 5. After configuring settings, click on **Test configuration** button to test whether all parameters are valid. Tip Use [network profiles](../Network-profiles/) to save and reuse your settings across multiple connections. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/AWS-SSO/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * AWS SSO [ AWS SSO ](./) Table of contents * AWS CLI * AWS SSO configuration * Connection configuration * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * AWS CLI * AWS SSO configuration * Connection configuration 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. [Cloud connection settings](/docs/dbeaver/AWS-Permissions) 4. AWS # AWS SSO Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. [AWS Single Sign- On](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) is a cloud-based single sign-on (SSO) service that makes it easy to centrally manage SSO access to AWS resources. You do not need to specify any user credentials explicitly in DBeaver connections configuration. All authorization is performed in a web browser in a 3rd party SSO provider, e.g. Google workspace, Microsoft AD portal, Facebook, etc. Tip DBeaver also supports AWS Systems Manager (SSM) for accessing databases. For detailed instructions on setting up AWS SSM, refer to the [AWS SSM setup guide](../AWS-SSM-Configuration/). ## AWS CLI¶ You need to install AWS CLI (Command Line Interface) utilities to enable SSO authorization. [AWS CLI installation](https://docs.aws.amazon.com/cli/latest/userguide/install- cliv2.html) AWS CLI version 2.2 is recommended. ## AWS SSO configuration¶ If you are in a corporate environment where all AWS configurations are provided by system administrators then you do not need to configure SSO parameters. Otherwise, you need to open the command shell (`win+R`), enter `aws configure sso`, press enter, and provide the required parameters. Read [configuration instructions](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure- sso.html) for the details. Restart DBeaver after the AWS CLI SSO configuration will be finished. ## Connection configuration¶ In the DBeaver database connection dialog you need to: * Set Authentication to `AWS IAM`. * Set Credentials to `AWS Profile`. * Choose the profile which was configured with AWS SSO (see the previous chapter). * Click on the `Enable SSO` check. Now you can connect. DBeaver will open a web browser with SSO authorization. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Accessibility-Guide/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * Accessibility [ Accessibility ](./) Table of contents * General * Screen readers support * Structure and navigation * Shortcuts * Colors and fonts * DBeaver Views and Wizards * Database Navigator * New Connection * Object Properties * SQL Editor * Result Set * Diagrams * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * General * Screen readers support * Structure and navigation * Shortcuts * Colors and fonts * DBeaver Views and Wizards * Database Navigator * New Connection * Object Properties * SQL Editor * Result Set * Diagrams 1. [DBeaver](/docs/dbeaver) 2. DBeaver configuration # Accessibility DBeaver offers you the ability to use most of its features with a keyboard and screen readers. Here you will find a guidelines on how to use DBeaver without a mouse in some common cases. Note DBeaver is tested primarily with standard Windows keyboard shortcuts for accessibility. ## General¶ ### Screen readers support¶ DBeaver provides support for various screen readers: * **NVDA**. Find more details in the [NVDA User Guide](https://www.nvaccess.org/files/nvda/documentation/userGuide.html). * **JAWS**. Access comprehensive information through the [JAWS Documentation](https://support.freedomscientific.com/Content/Documents/Manuals/JAWS/JAWS-Quick-Start-Guide.pdf). * **Narrator**. More information available at the [Narrator User Guide](https://support.microsoft.com/en-us/windows/complete-guide-to-narrator-e4397a0d-ef4f-b386-d8ae-c172f109bdb1). To change the screen reader in DBeaver, navigate to **Window - > Preferences -> User Interface -> Accessibility**. ### Structure and navigation¶ DBeaver is an application consisting of many parts, so-called Views, such as [**Database Navigator**](../Database-Navigator/), [**SQL Editor**](../SQL- Editor/), [**Data Editor**](../Data-Editor/), etc. A [**Toolbar**](../Application-Window-Overview/#toolbar) with many buttons inside each [**View**](../Application-Window-Overview/#workspace) and horizontal and vertical tabs allows you to switch between **Views** and inside them. **Main navigation shortcuts** \- You can switch Views by using `Ctrl`+`F7` | `⌘F7`. \- You can switch between buttons on the toolbars and menus using **Tab** and the **arrows**. **How to switch tabs** \- You can switch horizontal tabs by using `Ctrl`+`PageUp`/`PageDown`. \- Sub-tabs can be switched by using `Alt`+`PageUp`/`PageDown`. \- If there are vertical tabs inside the view, you can switch them by using `Ctrl`+`Alt`+`PageUp`/`PageDown` or `Ctrl`+`Shift`+`PageUp`/`PageDown`. When you focus on any interface object, such as a table, column, tab, or cell, you can open the **Context menu** to see all the actions available for that object. To open the Context menu, use `Shift` \+ `F10` | `⇧F10`. ### Shortcuts¶ Most of DBeaver's functions are accessible through special shortcuts. You can find them in **Window - > Preferences –> User Interface –> Keys**. If you mostly use the keyboard, you can switch to the **DBeaver Keyboard Only** scheme, which has additional shortcuts. [Learn more about DBeaver shortcuts](../Shortcuts/) ### Colors and fonts¶ **Themes** : DBeaver supports theme customization to enhance your user experience. Among the available options, DBeaver provides integration for the High-Contrast theme native to Windows systems. For more details on this and other themes, see our comprehensive [theme guide](../User-Interface-Themes/). **Fonts** : To change fonts in DBeaver, navigate to **Window - > Preferences –> User Interface -> Appearance -> Color and fonts**, and open DBeaver fonts. The **Main font** allows you to change the font family, size, and color in most elements of DBeaver's interface, including the **Database Navigator** and the **Data Grid**. The Monospace font changes the font in the **SQL Editor** and other **Views** with monospaced fonts. **Data Colorization** : You can [color rows in the **Data Grid**](../Data- View-and-Format/#coloring-rows-by-data-types) by following some rules or even by [selecting colors for particular data types](../Data-View-and- Format/#coloring-rows-by-data-types). ## DBeaver Views and Wizards¶ Let's see some comments on using the most popular **Views** in DBeaver with the keyboard and screen reader. ### Database Navigator¶ In the **Database Navigator** , you can view and open all the database connections and objects inside them. You can move between database objects and open nodes using arrows. * To view object properties, use `F4`. * To open **SQL Editor** associated with the selected object, use `F3`. [See all **Database Navigator** shortcuts](../Shortcuts/#database-navigator) ### New Connection¶ To [create a new connection](../Create-Connection/), open the **Wizard window** using `Ctrl+N` | `⌘N`, then type **connect** and select **Database connection**. [See **Connection** shortcuts](../Shortcuts/#connection) ### Object Properties¶ The [**Properties Editor**](../Properties-Editor/) is used to see all the information about database objects. When you focus on the first row of the table, NVDA reads the contents of the row with the corresponding column names. * You can open object properties with `F4`. * To switch between left-side tabs, use `Alt`+`Shift`+`Up` | `Alt`+`Shift`+`Down`. [See **Properties Editor** shortcuts](../Shortcuts/#properties-entity-editor) ### SQL Editor¶ The [**SQL Editor**](../SQL-Editor/) allows you to create and execute SQL scripts associated with a database connection. To open the **SQL Editor** , focus on the connection or table in the **Database Navigator** and press `F3`. To execute the SQL script under the cursor, press `Ctrl`+`Enter`. * [See **SQL Editor** shortcuts](../Shortcuts/#sql-editor) ### Result Set¶ When you place your focus on the first cell in the data table, the NVDA screen reader says the table name and the name of a column consisting of this cell. If you move from one cell to another, the screen reader announces the column names when you change focus. If you need to work with columns using the keyboard, you can select an entire column, copy the column name, and resize the column using special keyboard shortcuts. Some of them are only available in the **DBeaver Keyboard Only** scheme. [See Result Set shortcuts](../Shortcuts/#result-set) ### Diagrams¶ [**Diagrams**](../ER-Diagrams/) are fully accessible with the keyboard and the NVDA screen reader. You can move inside the table, move or resize it, and listen to the screen reader pronounce the table name and column names inside that table. [Learn more about Diagram shortcuts](../ER-Diagrams/#bindings) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Admin-Manage-Connections/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * Pre-configured database connections [ Pre-configured database connections ](./) Table of contents * Provide predefined connections * Importing connections from CSV or XML * Supported names * Sample CSV * Sample XML * Secure connections from editing * Using environment variables * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Provide predefined connections * Importing connections from CSV or XML * Supported names * Sample CSV * Sample XML * Secure connections from editing * Using environment variables 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Pre-configured database connections This guide describes how to manage/secure the DBeaver database connections. It is designed for System administrators. Regular users should check [this](../Create-Connection/) guide. ## Provide predefined connections¶ DBeaver keeps connections information in the project folder. By default, all projects reside in the [workspace](../Workspace-Location/). The default project folder is [workspace](../Workspace-Location/)\workspace6\General. **DBeaver up to 6.1.3** DBeaver keeps information about project connections in the `.dbeaver/data- sources.json`. file. All secured information (user name, password, secret keys, etc) is stored in the encrypted file, `.dbeaver/credentials- config.json`. DBeaver can load multiple connection files. Any files in the project folder matching the `.dbeaver/data-sources*.json` pattern will be loaded on the startup. So you can create a file, for example, `.dbeaver/data-sources-2.json` in the project folder and DBeaver will see it. **DBeaver < 6.1.3 (Legacy)** DBeaver keeps information about project connections in the `.dbeaver-data- sources.xml`. file. DBeaver can load multiple connection files. Any files in the project folder matching the `.dbeaver-data-sources*.xml` pattern will be loaded on the startup. So you can create a file, for example, `.dbeaver-data-sources-2.xml` in the project folder and DBeaver will see it. ## Importing connections from CSV or XML¶ You can import a connection from CSV or XML files. The CSV file must have a header row (first line of file) with column names (see list of supported columns below). The XML file should contain a top-level element and a set of nested elements. The connections config must be specified in the attributes of the nested elements. Attribute names are the same as the CSV column names. ### Supported names¶ Name | Meaning ---|--- name | Connection name url | JDBC URL host | Database server host name port | Database server port database | Database/schema name user | User name password | User password You can only specify the URL or the host/port/etc setting. | User name/password are optional. | ### Sample CSV¶ name,host,port,server,database,url,user,password,type Postgre Import XML 1,localhost,5432,,postgres,jdbc:postgresql://localhost:5432/postgres,postgres,postgres,dev Postgre Import XML 2,localhost,5432,,postgres2,jdbc:postgresql://localhost:5432/postgres2,postgres2,postgres2,prod ### Sample XML¶ ## Secure connections from editing¶ It is possible to set the connection settings as read-only (protected by password) \- Generate MD5 hash of your password. You can do it from the command line using Linux utility md5sum (`md5sum <<<"your password"`) or you can do it online - just google "MD5 hash online". \- Add field`lockPassword` in the connection descriptor (in `.dbeaver/data-sources.json` in `connections` element. So it will look like this: "postgres-jdbc-161537836e8-3e0957d039995715": { "provider": "postgresql", "driver": "postgres-jdbc", "name": "PostgreSQL - postgres", "save-password": true, "show-system-objects": true, "read-only": false, "folder": "PG", "lockPassword": "2ba81a47c5512d9e23c435c1f29373cb" ... } * If the user will try to change connection settings now, he/she will be asked for a password. ## Using environment variables¶ You can use references on environment variables in most of connection configuration properties. For example: "postgres-jdbc-161537836e8-3e0957d039995715": { "provider": "postgresql", "driver": "postgres-jdbc", "name": "PostgreSQL - postgres", "user": "${dbeaver.default-user}", ... } Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Admin-Manage-Drivers/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * Admin manage drivers [ Admin manage drivers ](./) Table of contents * Configure drivers with pre-installed jars * Provide predefined drivers configuration * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configure drivers with pre-installed jars * Provide predefined drivers configuration 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Admin preferences # Admin manage drivers ## Configure drivers with pre-installed jars¶ You can customize drivers configuration in the [workspace](../Workspace- Location/)/.metadata/.plugins/org.jkiss.dbeaver.core/drivers.xml file. If you have some pre-installed jar files you can reference them in drivers.xml. Example: Also in drivers.xml you can use the following variables to specify relative paths: Variable | Meaning ---|--- drivers_home | Standard DBeaver drivers location - ($workspace/drivers by default) dbeaver_home | DBeaver installation folder home | User home folder workspace | DBeaver workspace path For instance: Full drivers.xml example: ## Provide predefined drivers configuration¶ In some cases you may need to provide a driver's configuration or driver `jar` files for a number of DBeaver installations automatically. This can be done by adding a special parameter in the `dbeaver.ini` file: `-Ddbeaver.drivers.configuration-file=c:\some-path\dbeaver-drivers-config.xml` Tip Detailed instructions on finding `dbeaver.ini` are available in [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). This file has the same structure as `drivers.xml` file (see above) and it will be loaded _before_ `drivers.xml`. You can specify partial driver configuration. For example if you need to configure only the jar path then it may look like this: Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Admin-Manage-Preferences/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * Admin manage preferences [ Admin manage preferences ](./) Table of contents * Locating preference files * Importing and Exporting workspace configuration * Reading and modifying preference files * Preferences * Default navigator view for new connections * Miscellaneous navigator settings * Default transaction settings * Metadata settings * Query manager settings * Database Navigator settings * Error Logs settings * User Interface settings * SQL Editor settings * Data Editor settings * Drivers settings * Disable Windows Defender pop-up * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Locating preference files * Importing and Exporting workspace configuration * Reading and modifying preference files * Preferences * Default navigator view for new connections * Miscellaneous navigator settings * Default transaction settings * Metadata settings * Query manager settings * Database Navigator settings * Error Logs settings * User Interface settings * SQL Editor settings * Data Editor settings * Drivers settings * Disable Windows Defender pop-up 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Admin preferences # Admin manage preferences This guide describes how to set up an application preferences through configuration files without even booting it up. ## Locating preference files¶ Preference files have the extension `.prefs` and can be found in the [workspace](../Workspace-Location/) directory under the following path: `.metadata/.plugins/org.eclipse.core.runtime/.settings` You might not find a preference file you are interested in, if it has not been created yet. In this case, you will need to create one yourself. See the examples below to figure out which preference file you need. ## Importing and Exporting workspace configuration¶ You can easily import and export your workspace configuration. Follow the steps below to perform these actions: 1. Go to **File** -> **Import** (for importing) or **Export** (for exporting). 2. In the opened window, select **DBeaver** , then choose **Preferences** from the nested menu. 3. In the new window: 4. For importing, navigate to the location where the configuration file is stored, select the file, and click **Finish**. 5. For exporting, choose the destination where you want to save the configuration file, and click **Finish**. 6. If you are importing, DBeaver will prompt you to restart the application to apply the changes. Confirm the restart to complete the import process. ## Reading and modifying preference files¶ Preference files consist of key-value pairs glued together with `=` and separated with a line break: # file org.jkiss.dbeaver.test.prefs some.key=value1 some.other.key=value2 ## Preferences¶ You can place the following preferences in the `org.jkiss.dbeaver.core.prefs` file: ### Default navigator view for new connections¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- navigator.settings.default.preset | string | `simple` | `simple`, `advanced` | Sets the default view mode for a new connections.Do not specify this preference if you want to configure a custom preset. navigator.settings.default.showSystemObjects | boolean | `false` | `true`, `false` | Controls whether system objects must be shown.Used if preset is not specified. navigator.settings.default.showUtilityObjects | boolean | `false` | `true`, `false` | Controls whether utility objects must be shown.Used if preset is not specified. navigator.settings.default.showOnlyEntities | boolean | `false` | `true`, `false` | Controls whether only schemas and tables must be shown.Used if preset is not specified. navigator.settings.default.mergeEntities | boolean | `false` | `true`, `false` | Controls whether all tables must be shown in a single list (without any catalog or database).Used if preset is not specified. For more information, please see [Simple and Advanced View](../Simple-and- Advanced-View/). ### Miscellaneous navigator settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- navigator.settings.default.connectionPattern | string | `host_or_database` | expression with variables | Pattern for new connections title. navigator.show.folder.placeholders | boolean | `true` | `true`, `false` | Displays placeholders for special folders. Show special folders (e.g. Scripts) even if they were not created yet. navigator.sort.case.insensitive | boolean | `true` | `true`, `false` | Sorts items in case-insensitive mode. navigator.sort.forlers.first | boolean | `true` | `true`, `false` | Shows folders first. ### Default transaction settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- transaction.smart.commit | boolean | `false` | `true`, `false` | Enables smart commit mode. transaction.smart.commit.recover | boolean | `true` | `true`, `false` | Returns to auto-commit mode after transaction end. transaction.auto.close.enabled | boolean | `false` | `true`, `false` | Automatically ends (rollback) transaction after idle period. transaction.auto.close.ttl | integer | `900` | integer value | Timeout before transaction close. transaction.show.notifications | boolean | `true` | `true`, `false` | Shows transaction and notification. ### Metadata settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- database.meta.separate.connection | string | `DEFAULT` | `ALWAYS`, `NEVER` | Controls whether to open a separate connection for metadata read. Do not specify this preference if you want to use default settings. database.meta.casesensitive | boolean | `false` | `true`, `false` | Specifies the usage of case-sensitive names in DDL statements. database.props.expensive | boolean | `true` | `true`, `false` | Enables display of row count for tables. database.meta.server.side.filters | boolean | `true` | `true`, `false` | Enables filtering on the server side. ### Query manager settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- qm.queryTypes | string | `USER`, `USER_FILTERED`, `USER_SCRIPT` | `USER`, `USER_FILTERED`, `USER_SCRIPT`, `UTIL`, `META`, `META_DDL` | View for different query types. qm.objectTypes | string | `session`,`txn`,`query` | `session`,`txn`,`query` | Displays different object types. `txn` \- Transactions. qm.maxEntries | integer | `200` | integer value | Number of entries displayed per page. qm.storeLogs | boolean | `false` | `true`, `false` | Enables the saving of logs. qm.logDirectory | string | [workspace directory](../Workspace-Location/) | string value | Folder location for saving logs. qm.historyDays | integer | `90` | integer value | Number of days for storing logs. Info For more details on Query Manager, see [our article](../Query-Manager/). ### Database Navigator settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- navigator.show.connection.host | boolean | `true` | `true`, `false` | Displays the connection host name. navigator.show.objects.description | boolean | `false` | `true`, `false` | Displays the objects description. navigator.show.child.count | boolean | `false` | `true`, `false` | Display the number of children for expanded folders in the navigator tree. navigator.sort.case.insensitive | boolean | `false` | `true`, `false` | Order navigator nodes (not folders) alphabetically. navigator.sort.case.insensitive.ignore.case | boolean | `false` | `true`, `false` | Order navigator nodes without case sensitivity, for example, `A,a,B,b` Requires `navigator.sort.case.insensitive=true`. Otherwise, the setting won’t be saved correctly. navigator.show.statistics.info | boolean | `true` | `true`, `false` | Displays the statistics info. navigator.show.node.actions | boolean | `true` | `true`, `false` | Displays the actions icons. navigator.show.folder.placeholders | boolean | `true` | `true`, `false` | Displays placeholders for special folders. navigator.sort.forlers.first | boolean | `true` | `true`, `false` | Displays folders first. navigator.sort.case.insensitive | boolean | `false` | `true`, `false` | Orders elements alphabetically. navigator.color.nodes.all | boolean | `false` | `true`, `false` | Sets connection color for all elements. navigator.show.objects.tips | boolean | `true` | `true`, `false` | Displays object brief information. navigator.show.tooltips | boolean | `true` | `true`, `false` | Displays information about connection in a tooltip. navigator.show.tooltips.file.contents | boolean | `false` | `true`, `false` | Allows to show a description for a node. navigator.object.doubleClick | string | `EDIT` | `EXPAND` | The behavior of double-clicking on the node. navigator.connection.doubleClick | string | `EXPAND` | `EDIT`, `CONNECT`, `SQL_EDITOR`, `SQL_EDITOR_NEW` | The behavior of double-clicking on the connection. navigator.object.defaultEditorPage | string | `""` | `default.object.editor`,`org.jkiss.dbeaver.ui.editors.data.DatabaseDataEditor`,`org.jkiss.dbeaver.ui.editors.erd.editor.ERDEditorEmbedded` | Defines which editor will open upon double-clicking: the Properties Editor (`default.object.editor`), the Data Editor (`org.jkiss.dbeaver.ui.editors.data.DatabaseDataEditor`), or the ERD Editor (`org.jkiss.dbeaver.ui.editors.erd.editor.ERDEditorEmbedded`). navigator.expand.on.connect | boolean | `false` | `true`, `false` | Expands navigator tree on connect. navigator.restore.filters | boolean | `false` | `true`, `false` | Determines whether navigator filters should be restored upon reopening. navigator.long.list.fetch.size | integer | `5000` | integer values | Determines nodes limit for Navigator tree. navigator.restore.state.depth | integer | `0` | integer values | Restores the navigator expanded state up to a certain depth. ### Error Logs settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- logs.debug.enabled | boolean | `true` | `true`, `false` | Enables debug logs. logs.debug.location | string | `${workspace}/.metadata/dbeaver-debug.log` | string values | Location of the log file. logs.files.output.maxSize | integer | `10485760` | integer values | Maximum log file size (KB). logs.files.output.maxCount | integer | `3` | integer values | Maximum backup log files count. ### User Interface settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- ui.auto.update.check | boolean | `true` | `true`, `false` | Enables automatic updates check. platform.language | string | `en` | `en`, `zh_CN`, `ru`, `fr`, `de`, `it`, `ja`, `es`, `pt`, `ko`, `zh_TW`, | Platform language setting. java.client.timezone | string | operating system time zone | [time zones](../JDBC-Time-Zones/) | Time zone setting. notifications.enabled | boolean | `true` | `true`, `false` | Determines whether notification popups are allowed to appear. notifications.closeDelay | integer | `3000` | integer values | Defines the timeout (in ms) before a notification will disappear. ### SQL Editor settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- database.editor.separate.connection | string | `DEFAULT` | `ALWAYS`, `NEVER` | Opening a separate connection for each editor. database.editor.connect.on.activate | boolean | `true` | `true`, `false` | Connects on editors activation. database.editor.connect.on.execute | boolean | `false` | `true`, `false` | Connects on query execution. SQLEditor.autoSaveOnChange | boolean | `false` | `true`, `false` | Auto-saves after any modifications. SQLEditor.autoSaveOnClose | boolean | `false` | `true`, `false` | Auto-saves editor on close. SQLEditor.autoSaveOnExecute | boolean | `false` | `true`, `false` | Saves editor on query execution. SQLEditor.autoSaveActiveSchema | boolean | `true` | `true`, `false` | Saves/restores active schema. SQLEditor.resultSet.closeOnError | boolean | `false` | `true`, `false` | Closes results tab on error. SQLEditor.resultSet.replaceCurrentTab | boolean | `true` | `true`, `false` | Replaces active result tab on single query execution. SQLEditor.resultSet.orientation | string | `HORIZONTAL` | `VERTICAL` | Result view orientation. SQLEditor.outputPanel.autoShow | boolean | `true` | `true`, `false` | Opens output viewer on new messages. SQLEditor.outputPanel.autoShow | integer | `20` | integer values | Sets maximum of result tabs for single query. SQLEditor.ContentAssistant.auto.activation.enable | boolean | `true` | `true`, `false` | Enables SQL Assistant auto-activation. SQLEditor.ContentAssistant.activate.hippie | boolean | `false` | `true`, `false` | Uses Hippie Engine for autocompletion. SQLEditor.ContentAssistant.auto.activation.delay | integer | `0` | integer values | Auto activation delay (ms). SQLEditor.ContentAssistant.auto.keystrokes.activation | boolean | `true` | `true`, `false` | Activates SQL Assistant on typing. SQLEditor.ContentAssistant.insert.single.proposal | boolean | `true` | `true`, `false` | Auto inserts proposal in SQL assistant if there is only one option. SQLEditor.ContentAssistant.autocompletion.tab | boolean | `true` | `true`, `false` | Use Tab for autocompletion in SQL Assistant. SQLEditor.ContentAssistant.insert.case | integer | `0` | `1`, `2` | SQL Assistant insertion case (1- Upper case, 2 - Lower case). SQLEditor.ContentAssistant.replace.word | boolean | `false` | `true`, `false` | Sets up whether to replace the current word on accepting autocompletion proposal. SQLEditor.ContentAssistant.proposals.short.name | boolean | `false` | `true`, `false` | Uses short object names in SQL Assistant. SQLEditor.ContentAssistant.show.helpTopics | boolean | `false` | `true`, `false` | Shows server help topics in SQL Assistant. SQLEditor.ContentAssistant.show.values | boolean | `true` | `true`, `false` | Proposes values for the given attribute. Note that it can drastically degrade performance when working with large tables, as it selects distinct values. sql.proposals.insert.table.alias | string | `PLAIN` | `NONE`, `EXTENDED` | Inserts table aliases (in FROM clauses). SQLEditor.format.activeQuery | boolean | `true` | `true`, `false` | Enables formatting of the query under cursor only. script.auto.folders | boolean | `false` | `true`, `false` | Creates script folder for each connection. com.dbeaver.ee.vqb.disabled | boolean | `false` | `true`, `false` | Disables the Visual Query Builder in the SQL Editor. ### Data Editor settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- resultset.autofetch.next.segment | boolean | `true` | `true`, `false` | Automatically loads the next data segment when the current one is fully processed or viewed. resultset.reread.on.scroll | boolean | `true` | `true`, `false` | Refreshes the data when moving to the next page. resultset.maxrows.sql | boolean | `false` | `true`, `false` | Modifies the source SQL query to scroll through or limit results. This is typically achieved using the LIMIT/OFFSET SQL clause. resultset.order.mode | string | `SMART` | `CLIENT_SIDE`, `SERVER_SIDE`, `SMART` | Specifies the method of sorting returned query results. resultset.read.metadata | boolean | `true` | `true`, `false` | Retrieves information about the table structure, specifically the unique keys. resultset.read.references | boolean | `true` | `true`, `false` | Retrieves information about the table structure, specifically the foreign keys. resultset.cancel.timeout | integer | `5000` | integer values | Defines the duration (in milliseconds) the system waits before cancelling a non-responsive query. sql.query.filter.force.subselect | boolean | `false` | `true`, `false` | Forces the usage of subqueries when applying filters to the data. resultset.column.label.ignore | boolean | `false` | `true`, `false` | Prioritizes column names over column labels when referencing data. resultset.edit.key.use_all_columns | boolean | `false` | `true`, `false` | Forms a virtual composite key using all table columns for data saving. If set to `true`, this will determine the action taken if a key element is missing. If set to `false`, no action will be taken when a key element is missing. resultset.edit.disableIfKeyMissing | boolean | `false` | `true`, `false` | Prevents data modification when a primary key is absent. This setting defines the action taken when the assumed primary key is missing. keep.statement.open | boolean | `false` | `true`, `false` | Closes the result set after a selection. To view a cursor column value, the option should be enabled. resultset.datetime.editor | boolean | `false` | `true`, `false` | Enables the advanced datetime editor in the data editor. resultset.edit.new.row.after | boolean | `true` | `true`, `false` | Places newly inserted rows immediately following the currently selected row. resultset.edit.refreshAfterUpdate | boolean | `true` | `true`, `false` | Automatically refreshes the data after making changes. resultset.filter.use.navigator | boolean | `true` | `true`, `false` | Employs filters in the navigator to refine the displayed data. resultset.confirm.beforeSave | boolean | `false` | `true`, `false` | Displays a prompt asking for a confirmation before saving changes. resultset.show.errorDialog | boolean | `false` | `true`, `false` | Presents error messages in a separate dialog box. resultset.mark.cell.value.occurrences | boolean | `false` | `true`, `false` | Highlights instances of the selected cell's value within the data set. resultset.image.browser | boolean | `true` | `true`, `false` | Displays images in the web browser. resultset.behavior.autoSwitchMode | boolean | `false` | `true`, `false` | Allow to switch between **Record mode** and **Grid mode** when dealing with single or multiple rows. When set to `true`, the system will automatically switch modes based on the number of rows selected (**Record mode** for a single row, **Grid mode** for multiple rows). resultset.calc.columnWidthByValues | boolean | `false` | `true`, `false` | Displays the description for each column in the header. resultset.show.columnDescription | boolean | `false` | `true`, `false` | Adjusts the width of each column based on the content of its cells. resultset.show.connectionName | boolean | `false` | `true`, `false` | Displays the name of the connection in the status section. resultset.transform.complex.type | boolean | `true` | `true`, `false` | Enables the visualization of complex columns (such as objects, structures and arrays). resultset.show.rightJustifyNumbers | boolean | `true` | `true`, `false` | Allows right-justify numbers. resultset.show.rightJustifyDateTime | boolean | `true` | `true`, `false` | Aligns date and time values to the right side of their respective cells or columns. resultset.behavior.autoCompleteProposial | boolean | `true` | `true`, `false` | Activates the auto-completion feature in the data filter text field. resultset.show.oddRows | boolean | `true` | `true`, `false` | Marks odd and even rows in the grid. resultset.show.colorizeDataTypes | boolean | `false` | `true`, `false` | Colorized data types in the grid. resultset.show.attIcons | boolean | `true` | `true`, `false` | Displays icons representing the data types of each column in the grid. resultset.show.attFilters | boolean | `true` | `true`, `false` | Enables the display of attribute filters in the grid. resultset.show.attrOrder | boolean | `false` | `true`, `false` | Shows asc/desc order icon in column header. resultset.show.collections.inline | boolean | `false` | `true`, `false` | Enables the inline display of collections within the grid. resultset.show.boolean.checkbox | boolean | `true` | `true`, `false` | Represents boolean values in the grid as checkboxes. resultset.show.whitespace.characters | boolean | `false` | `true`, `false` | Displays whitespace characters within the grid. resultset.show.column.position | boolean | `false` | `true`, `false` | Shows column order in the column headers. resultset.grid.value.format | string | `UI` | `EDIT`, `NATIVE`, `UI` | Determines the format in which values are displayed within the grid. resultset.grid.value.format | integer | `30` | integer values (from `0` to `100`) | Determines the maximum percentage of width that a column can occupy in the grid. resultset.highlight.selectedRows | boolean | `true` | `true`, `false` | Enables the highlighting of entire rows when one or more cells within those rows are selected. resultset.hScroll.smooth | boolean | `true` | `true`, `false` | Enables smooth scrolling within the DBeaver. resultset.show.boolean.toggleOnClick | boolean | `true` | `true`, `false` | Allows the boolean values to be toggled or switched between true and false with a single click. resultset.behavior.inlineEnter | boolean | `false` | `true`, `false` | Selects the next cell after the inline edit completed (or finished). resultset.behavior.doubleClick | string | `INLINE_EDITOR` | `NONE`, `EDITOR`, `INLINE_EDITOR`, `COPY_VALUE`, `COPY_PASTE_VALUE` | Defines the action taken when a cell in a grid is double-clicked (Options: EDITOR, INLINE_EDITOR, COPY_VALUE, COPY_PASTE_VALUE, NONE). resultset.show.row.batch.size | integer | `1` | integer values | Number of consequent rows with the same background color. Default = 1 means odd/even rows coloring. resultset.text.tab.size | integer | `4` | integer values | Determines tab size in plain text. resultset.text.max.column.size | integer | `255` | integer values | Determines the maximum length of a column's content when viewing data in plain text. resultset.text.value.format | string | `EDIT` | `EDIT`,`UI`, `NATIVE` | Determines how plain text values are displayed in DBeaver. resultset.text.show.nulls | boolean | `false` | `true`, `false` | Shows `NULL` if this setting is enabled or nothing if disabled. resultset.text.line.number | boolean | `false` | `true`, `false` | Enables the display of line numbers. resultset.text.delimiter.leading | boolean | `false` | `true`, `false` | Enables trailing delimiter in plain text for Grid Representation. resultset.text.delimiter.trailing | boolean | `true` | `true`, `false` | Enables trailing delimiter in plain text for Grid Representation. resultset.text.delimiter.top | boolean | `false` | `true`, `false` | Enables top delimiter in plain text for Grid Representation. resultset.text.delimiter.bottom | boolean | `false` | `true`, `false` | Enables bottom delimiter in plain text for Grid Representation. resultset.text.extra.spaces | boolean | `false` | `true`, `false` | Enables extra spaces in plain text for Grid Representation. resultset.string.use.content.editor | boolean | `false` | `true`, `false` | Opens separate string editor instead of dialog. resultset.binary.representation | string | `string` | `hex`, `base64`, `string` | Determines the format in which binary data is displayed. resultset.binary.editor | string | `EDITOR` | `EDITOR`, `PANEL` | Enables to change the binary data editor. Choose between `EDITOR` (dedicated binary data editor) or `PANEL` (dialog window for viewing/editing binary data). resultset.binary.stringMaxLength | integer | `32` | integer values (max: `3200`) | Determines the maximum length of binary strings that can be displayed in the binary editors. content.memory.maxsize | integer | `10000` | integer values (max: `1000000000`) | Determines the maximum length of LOB (Large Object) data that will be kept in memory when working with binary editors. content.hex.encoding | string | `UTF-8` | All available encodings from the current JVM | Allows to specify the character encoding used when interpreting binary data as strings. hex.font.name | string | `Courier New` | `Courier New`, `Andale Mono`, `Menio`, `Monaco`, `PT Mono` | Allows to specify the name of the font to be used in the data editor. hex.font.style | integer | `0` | `0` \- Regular, `1` \- Bold, `2` \- Italic, `3` \- Bold Italic | Allows to choose the font style for the data editor. hex.font.size | integer | `10` | `6` \- `14`, `16`, `18`, `22`, `32`, `72` | Allows to choose the font style for the data editor. default.hex.width | integer | `8` | `4`, `8`, `16` | Allows to choose the default width for the data editor. resultset.json.maxObjectMembers | integer | `200` (max: `2000000000`) | integer values | Specifies the threshold for collapsing JSON objects in the data editor. resultset.json.maxArrayElements | integer | `200` (max: `2000000000`) | integer values | Determines the threshold for collapsing arrays in the JSON data editor. resultset.json.maxElementNesting | integer | `4` (max: `400000000`) | integer values | Determines which objects in JSON will be collapsed (hidden) if their nesting level exceeds a specified threshold. dataformat.type.number.nativeSpecialValues | boolean | `false` | `true`, `false` | Instructs the data editor to utilize the native formatting for special values. dataformat.type.number.useGrouping | boolean | `false` | `true`, `false` | Indicates whether grouping is used to display numbers. dataformat.type.number.useTypeScale | boolean | `false` | `true`, `false` | Uses column/attribute data type scale as minimum fraction digits number. dataformat.type.number.roundingMode | string | `UNNECESSARY` | `UP`, `DOWN`, `CEILING`, `FLOOR`, `HALF_UP`, `HALF_DOWN`, `HALF_EVEN`, `UNNECESSARY` | Determines the rounding mode used for numerical values. dataformat.type.number.minIntegerDigits | integer | `1` | integer values | Determines the minimum number of digits to display for integer values. dataformat.type.number.minFractionDigits | integer | `0` | integer values | Determines the minimum number of fractional digits displayed. dataformat.type.number.maxIntegerDigits | integer | `2147483647` | integer values | Defines the maximum number of digits allowed for an integer value. dataformat.type.number.maxFractionDigits | integer | `10` | integer values | Specifies the maximum number of fraction digits allowed. dataformat.type.number.groupingSize | integer | `3` | integer values | Determines the grouping size for displaying numeric values. dataformat.type.timestamp.pattern | string | `yyyy-MM-dd HH:mm:ss.SSSS` | timestamp format | Determines the format for displaying and editing timestamp data. dataformat.type.timestamptz.pattern | string | `yyyy-MM-dd HH:mm:ss.SSS Z` | timestamp with timezone format | Determines the format for displaying timestamp values with timezone information. dataformat.type.date.pattern | string | `yyyy-MM-dd` | date format | Determines the format used for displaying and editing dates. dataformat.type.time.pattern | string | `HH:mm:ss` | time format | Determines the format used for displaying and editing time. dataformat.type.timetz.pattern | string | `HH:mm:ss Z` | time with timezone format | Determines the format used for displaying and editing time with timezone. The preferences of **GIS Viewer** from **Data Editor** you can find in the `org.jkiss.dbeaver.data.gis.view.prefs` file: Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- gis.view.minZoomLevel | integer | `0` | integer values | Determines the maximum level of zoom. gis.view.maxObjectsRender | integer | `10000` | integer values | Determines the maximum number of objects that can be displayed. gis.view.defaultSRID | integer | `4326` | integer values | Determines the default Spatial Reference Identifier (SRID). ### Drivers settings¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- ui.drivers.home | string | `path/to/DBeaverData/drivers` | string values | Specifies the local folder for driver storage. ui.proxy.host | string | `` | string values | Identifies the host for the HTTP proxy when downloading drivers. ui.proxy.port | integer | `1080` | integer values | Specifies the port number used by the HTTP proxy during driver downloads. ui.proxy.user | string | `` | string values | Determines the username for accessing proxy during driver downloads. ui.proxy.password | string | `` | string values | Sets the password required for the proxy during driver downloads. ui.drivers.sources | string | `https://dbeaver.io/files/jdbc/` | string values | Provides the URL where driver files can be downloaded. ui.drivers.global.libraries | string | `` | string values | Defines the global classpath from which global libraries can be loaded. ui.drivers.version.update | boolean | `false` | `true`, `false` | Determines whether the system checks for new driver versions. ## Disable Windows Defender pop-up¶ Name | Type | Default Value | Allowed Values | Description ---|---|---|---|--- `windows.defender.startup.check.skip` | boolean | `false` | `true`, `false` | Skips the Windows Defender SmartScreen check at startup. Tip Add this preference to `DBeaverData/workspace6/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.ui.prefs` in your [workspace](../Workspace-Location/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Admin-Preference-Restrictions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * Admin preference restrictions [ Admin preference restrictions ](./) Table of contents * Modifying the DBeaver configuration file * Using Windows Registry * Configuration options * Registry and configuration file parameters * Configuration file parameters * Master password policy settings * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Modifying the DBeaver configuration file * Using Windows Registry * Configuration options * Registry and configuration file parameters * Configuration file parameters * Master password policy settings 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Admin preferences # Admin preference restrictions This guide outlines the steps for enhancing security and control in DBeaver by restricting specific functionalities. For Windows, Mac, and Linux, restrictions in the `dbeaver.ini` file can be implemented, while Windows users can also leverage the Registry for additional control. Tip Detailed instructions on finding `dbeaver.ini` are available in [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). Follow the appropriate steps based on your operating system and preference. ## Modifying the DBeaver configuration file¶ 1. Navigate to the directory containing the `dbeaver.ini` file. 2. Use a text editor to open the configuration file. 3. Locate the `-vmargs` line within the file. 4. Add the desired settings from the Configuration options, ensuring each setting is preceded by `-D` (for instance `-Dpolicy.wd.check.disabled=true`) and placed below the `-vmargs` line. 5. Save the edited file. 6. Restart DBeaver to apply changes. ## Using Windows Registry¶ 1. Open the Registry Editor by typing `regedit` in the Run dialog (`Win + R`). 2. Navigate to the following path in the Registry: `HKEY_CURRENT_USER\Software\DBeaver Corp\DBeaver\policy` 3. Create a new value for each setting, from the Configuration options based on desired restrictions. 4. Exit the Registry Editor and restart DBeaver to apply the changes. Important Editing the Windows Registry can significantly affect your system. Always make sure to back up the registry before making any changes. For more information on how to work with the Windows Registry, refer to the [Microsoft Documentation on Registry Editing](https://learn.microsoft.com/en- us/windows/win32/sysinfo/registry). ### Configuration options¶ This section consolidates the configuration options, applicable through Windows Registry keys and as settings in the DBeaver configuration file. #### Registry and configuration file parameters¶ This section outlines the parameters that can be configured either through the Windows Registry or directly in the `dbeaver.ini`. Registry key/Variable Name | Type | Default value | Allowed values | Description ---|---|---|---|--- `policy.data.export.disabled` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Restricts ability to export data from databases. `policy.data.import.disabled` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Restricts ability to import data to databases. `policy.data.copy.disabled` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Restricts ability to copy data from databases. `policy.data.edit.disabled` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Restricts ability to edit data in databases. `policy.sql.execution.disabled` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Restricts ability to execute SQL scripts. `policy.software.install.disabled` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Blocks ability to install new software and access the Eclipse marketplace. `policy.software.update.disabled` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Prevents ability to check for DBeaver updates. `connection.credentials.save.restricted` | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Disables the ability to save database credentials across all user profiles. `policy.wd.check.disabled` ![](../images/commercial.png) | `DWORD`/`Boolean` | `0`/`false` | `0`/`false`, `1`/`true` | Disables the Windows Defender SmartScreen check at startup. #### Configuration file parameters¶ This section details the parameters that can be set only in the `dbeaver.ini`. Variable Name | Default Value | Allowed Values | Description ---|---|---|--- `dbeaver.disable.secure.masking` | `false` | `false`, `true` | Disables the masking of sensitive information in log files. #### Master password policy settings¶ Registry key/Variable Name | Type | Default value | Allowed values | Description ---|---|---|---|--- `policy.master.password.disable` | `DWORD`/`Boolean` | `1`/`true` | `0`/`false`, `1`/`true` | Disables the requirement for a master password. `policy.master.password.policy` | `REG_SZ`/`String` | `{"minLength": 8, "minLetterCount": 1, "minNumberCount": 1, "minSymbolCount": 0, "requireMixedCase": true}` | `{"minLength": int, "minLetterCount": int, "minNumberCount": int, "minSymbolCount": int, "requireMixedCase": boolean}` | Specifies the master password policy configuration. This is an optional setting, applicable only when the `policy.master.password.disable` policy is enabled. `minLength` sets the minimum length, `minLetterCount` determines the minimum number of letters, `minNumberCount` establishes the minimum number of digits, `minSymbolCount` sets the minimum number of symbols, `requireMixedCase` sets if mixed case letters are required. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Admin-Variables/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * Admin variables [ Admin variables ](./) Table of contents * Variables * What are variables * Using variables * The Variable resolution * Declare external variables in a file * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Variables * What are variables * Using variables * The Variable resolution * Declare external variables in a file 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Admin preferences # Admin variables ## Variables¶ **Disclaimer: this article does** NOT**cover variables used in SQL editor.** ### What are variables¶ A variable is a special template which is replaced with an associated value. Variables help keep your configuration clean and tidy by avoiding unnecessary repetitions: instead of manually replacing each occurrence of some value, you can replace the value of a variable just once and its occurrences will be kept intact. Variables are available in a lot of places. You might find them in: 1. The Connection settings 2. The SSH tunnel settings 3. [Data Transfer](../Data-transfer/) and in other tasks 4. The Command Line Interface Wherever you find variables available in the user interface, a hint will usually be present: ![](../images/admin/variables-hint.png) By clicking on it, a separate window will open showing all the available variables with their descriptions and values: ![](../images/admin/variables-hint-dialog.png) ### Using variables¶ To use the variables you need to utilize a special syntax: ${variable_name} Where `variable_name` is a variable name which you want to use. The window shown above already contains `${` a `}` anchors so you do not need to specify them multiple times. Variables may be a part of something bigger: e.g., a part of a path. For example, if some file lies under the user's root folder, you may want to use variable `home`: `${home}`: `${home}/path/to/file.txt`. ### The Variable resolution¶ A value of a particular variable may be resolved from different places depending on its origin. The resolution is performed in the following order (from the highest to the lowest priority): 1. Dialog, where a specific variable is used 2. Datasource-specific variables (`host`, `port`, `server`, `database`, etc.) 3. Application-specific variables (`application.name`, `application.version`, `home`, etc.) 4. Environment variables. For additional information see [Wikipedia](https://en.wikipedia.org/wiki/Environment_variable). 5. External configuration (see the below) If you have an environment variable called `home`, it will be resolved in the application-specific variable because it has higher priority. ### Declare external variables in a file¶ You can create a file and fill it with pairs of named values and pass it to DBeaver using the `-vars` [command-line](../Command-Line/) argument. Variables from this file can be accessed by other command-line arguments, in the data transfer wizard, and in other places that support variable resolutions. For example, you may want to put your credentials in that file to avoid showing them to everyone else: # Lines that start with the `#` symbol are comments and therefore ignored. sampleVar1=abc someOtherVar=DBeaver is cool password=P4$$w0r3 You can use them as such: dbeaver.exe -vars C:\secrets.properties -con 'driver=|url=|password=${password}' Here, the `-con` argument has the `${password}` variable that will be replaced with `P4$$w0r3` defined in the example file from above. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Advanced-Metadata-Read-Actions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * Advanced metadata actions [ Advanced metadata actions ](./) Table of contents * Available actions * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Available actions 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. AI functions # Advanced metadata actions ![tag-outline](/docs/includes/icons/tag-outline.svg)Since 25.3 This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Metadata actions let you quickly inspect parts of your database. These actions are read-only and safe to use in any environment. Info By default, DBeaver sends only table and column names to the AI provider. No other metadata is shared unless you enable the metadata actions. ![](../images/ai/ai-functions-metadata-read.png) To use the actions: 1. Open [AI chat](../AI-chat/) on the connection you want to explore 2. Write a prompt that describes what you want to inspect Note To use an action, make sure it’s turned on in the [Functions settings](../AI-Assistance-settings/#functions). 3. AI reads your request and returns a small sample of data directly in the chat Tip Set a [scope](../AI-chat/#defining-the-scope) if you want AI to focus on a specific object. ## Available actions¶ Use it when you want to quickly inspect the contents of a table without writing SQL or opening editors. Just describe what you want in AI chat, and the assistant returns a few rows. Action | What it does | What happens | Example ---|---|---|--- **Read table sample rows** | Shows a small set of rows from a table without opening editors or writing SQL | \- DBeaver reads only a few rows \- Result appears directly in AI chat \- No SQL and no editors are required | `"show a few rows from Album table"` Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Apache-Hive/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * Apache Hive [ Apache Hive ](./) Table of contents * Apache Hive specialty * Setting up * Apache Hive connection settings * Connection details * Apache Hive driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Apache Hive with DBeaver * Apache Hive database objects * Apache Hive features * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Apache Hive specialty * Setting up * Apache Hive connection settings * Connection details * Apache Hive driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Apache Hive with DBeaver * Apache Hive database objects * Apache Hive features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Apache Hive This guide provides instructions on how to set up and use Apache Hive with DBeaver. Before you start, you must create a connection in DBeaver and select Hive. If you have not done this, please refer to our [Database Connection](../Create- Connection/) article. DBeaver interacts with the Hive server using a specific driver. It supports all versions of Hive, but the correct driver must be selected: use `Hive 2` for versions 2.x and earlier, and `Hive 4` for version 4 and later. DBeaver also supports Hive extensions such as Kyuubi and Spark, depending on your environment configuration. You must select the appropriate driver in the **Connect to a database** window for these extensions. ![](../images/database/hive/hive-drivers.png) Tip Systems like Impala use Hive-compatible drivers, so the standard Hive JDBC driver works in this case. ## Apache Hive specialty¶ Apache Hive is a data warehouse system built on top of Hadoop for querying and analyzing large datasets using a SQL-like language called HiveQL. It's optimized for batch processing and is commonly used for data summarization, ad-hoc queries, and analysis of structured data. Hive translates SQL queries into MapReduce jobs, making it well-suited for handling large-scale data stored in Hadoop Distributed File System (HDFS). Hive is a good fit for OLAP- style workloads and integrates with other big data tools in the Hadoop ecosystem. Info For more detailed information and a comprehensive understanding of Apache Hive, see the [official documentation](https://cwiki.apache.org/confluence/display/Hive/Home). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH and proxies for Hive. ## Apache Hive connection settings¶ The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/hive/hive-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **URL** | If you are connecting via URL, enter the URL of your Hive database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your Hive database here. **Database/Schema** | Enter the name of the Hive database you want to connect to. **Port** | Enter the port number for your Hive database. The default Hive port is `10000`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Hive database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Apache Hive driver properties¶ The settings for Hive **Driver properties** enable you to adjust the performance of the Hive driver. These adjustments can influence the efficiency, compatibility, and features of your Hive database. You can customize the Hive driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Hive database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Hive database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Apache Hive with DBeaver¶ DBeaver provides a host of features designed for Hive databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### Apache Hive database objects¶ DBeaver lets you view and manipulate a wide range of Hive database objects. DBeaver has extensive support for various Hive metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases/Schemas * Tables * Columns * Views Info Hive doesn’t support referential integrity, so you won’t see primary keys or foreign keys. Diagrams also aren’t relevant. ## Apache Hive features¶ DBeaver is not limited to typical SQL tasks. It also includes features specific to Hive. Beyond regular SQL operations, DBeaver provides a range of Hive-oriented capabilities, such as: Category | Feature ---|--- Data Types | Hive-specific types like `ARRAY`, `STRUCT`. File System | HDFS. Query Language | HiveQL (SQL-like query language). Additional features compatible with Hive, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Data Management | [Data Compare](../Data-compare/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Application-Window-Overview/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * Application window overview [ Application window overview ](./) Table of contents * Menu Bar * Toolbar * Shortcut Bar * Workspace * Changing Workspace Layout * Managing View and Editors * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Menu Bar * Toolbar * Shortcut Bar * Workspace * Changing Workspace Layout * Managing View and Editors 1. [DBeaver](/docs/dbeaver) 2. Getting started # Application window overview The DBeaver window contains a menu bar, a toolbar, a workspace with one or more editors and views, and a status bar: ![](../images/ug/appwindow-with-markup.png) ## Menu Bar¶ By default, the menu bar contains the following menus: * The **File** menu contains menu items for creating files, folders, [projects](../Projects/), [database connections](../Create-Connection/), database projects, [Diagrams](../ER-Diagrams/), and Import and Export items. * The **Edit** menu contains global commands like Cut, Copy, Paste, Delete and [Add Bookmark](../Bookmarks/) targeted at the active element. * The **Navigate** menu allows navigation through scripts and database objects. * The **Search** menu provides options to [search](../Search-Tool/) among files database objects and across data. * The **SQL Editor** menu is for opening [SQL Editor](../SQL-Editor/) and managing its appearance. * The **Database** menu allows the management of database drivers, connections, and transactions and reconnecting to and disconnecting from a database. * The **Window** menu includes items to manage the look of DBeaver window: show/hide and minimize/maximize views and editors, display bars, split editors, and manage other preferences. * The **Help** menu contains links to information and help resources, and menu items to check the version number and availability of updates. You can customize the menu bar and the list of menu items to display; for this, go to **Window** -> **Customize Perspective** -> **Menu Visibility** tab. ## Toolbar¶ The toolbar contains buttons for the most basic and frequently used commands: ![](../images/ug/app-toolbar.png) Some buttons are enabled (colored) and others are disabled (grey). The sets of enabled and disabled buttons change depending on which editor is active in the workspace. Only enabled buttons apply to the active view or editor. Tip The toolbar can be customized. For more information, please consult [our customization guide](../Toolbar-Customization/#top-toolbar-customization). ## Shortcut Bar¶ There are two shortcut bars - one on the left and one on the right side of the workspace zone. Shortcut bars host shortcuts of views and editors and appear if at least one view or editor is minimized, otherwise, they are hidden. ## Workspace¶ Views are windows within the workspace that provide presentations and ways to navigate the information. For more information about particular views, see the [Views](../Views/) article. Editors are windows in which you can interact with the content of files and databases. Info For more information on Editors, see [Database Object Editor](../Database- Object-Editor/). Both views and editors can appear as separate windows or tabs stacked with other views/editors in a tabbed window. The following image shows the title bar of a tabbed window. They become hidden if tabs do not fit in the title bar of a tabbed window. To see the list of hidden tabs, click the Show List icon that also indicates their number: ![](../images/ug/show-list-icon.png) Several views and editors can be opened simultaneously in the workspace, but only one can be active at a time. You can change the layout of the workspace by opening and closing views, docking them in different positions in the workspace, collapsing them to the shortcut bar, or expanding them to occupy the whole workspace and restoring them to the latest docked position. ### Changing Workspace Layout¶ You can move views and editors around the workspace and dock them in different positions: * As a tab in a tabbed window * As a separate window with a vertical or horizontal layout in any zone of the workspace You can also swap locations of two views or editors. To dock a view to a position in the workspace, press and hold the view's title bar, then drag and drop it onto the desired position. You can resize the view and editor windows. To resize, place the cursor on the window's border until it changes to a double-ended arrow, then click and drag the edge to the needed size. To close a view or editor, click the Close button, or right-click the title bar of the view / editor, then click one of the options on the context menu (they change depending on the configuration of windows): * **Close** \- to close the active window or tab in a tabbed window. * **Close Others** (for editors and views that appear as tabs in tabbed windows) - to close all tabs of the current tabbed window except the active tab. * **Close Tabs to the Right / Left** (also for tabbed windows) - to close all tabs of the current tabbed window that are located to the right / left of the active tab. * **Close All** \- to close all tabs of a tabbed window (close the window). ### Managing View and Editors¶ All views and editors have the **Close** , **Minimize** and **Maximize** buttons: ![](../images/ug/view-editor-controls.png) The Maximize button changes to the Restore button when a view or editor is maximized. To maximize a view or editor to the size of the whole workspace, do one of the following: * Click the Maximize button in the upper-right corner of the view. * Double-click the title bar of the view or editor. * On the **Window** menu, click **Appearance** -> **Maximize Active View or Editor**. When one view is maximized, other views and editors appear as shortcuts on the shortcut bar. To restore a maximized view or editor to its latest docked position, double- click its title bar or the **Restore** button in its upper-right corner. When you minimize a view, it wraps into a shortcut on the shortcut bar: ![](../images/ug/views-editors-shortcuts.png) The shortcuts of views and editors may appear on the left or the right shortcut bar, depending on the latest docked position of the view or editor. To minimize a view, do one of the following: * Click the **Minimize** button in the upper-right corner of the view. * On the Window menu, click **Appearance** -> **Minimize Active View or Editor**. To restore a minimized view or editor to its previous position, click the Restore button on its shortcut in the shortcut bar. To restore a minimized view or editor to a new position, click the view / editor name button under the restore button. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-DBeaver-profile/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * DBeaver profile [ DBeaver profile ](./) Table of contents * Settings * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Settings 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Database authentication models # DBeaver profile Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver offers a feature for setting up authentication profiles. This DBeaver Profile authentication type streamlines database management by allowing the creation of unique profiles for each authentication method. It effectively reduces the complexity and increases the efficiency of managing database connections. ![](../images/auth_methods/DBeaver_profile/dbeaver-profile-authentication- configuration.png) ## Settings¶ 1. From the **Authentication** dropdown menu, select the **DBeaver profile** method. 2. If you already have a profile set up, select it from the **Profile** dropdown. 3. If you don't have a profile yet, click the **Manage profiles** button to start creating a new one. 4. In the window that opens, click the **Create button** and name your profile as per your preference. ![](../images/auth_methods/DBeaver_profile/dbeaver-profile-creation.png) 5. Select the type of authentication from the available options and fill out the required fields. Tip If you check the **Save credentials locally** option, you will not be asked to input your credentials every time you connect. 6. After filling in all the necessary fields, click **OK** to save your profile settings. 7. Back in the main connection settings window, click on the **Test Connection** button to verify if your settings are correct. 8. If everything is configured correctly, DBeaver should now be able to connect to your database using the **DBeaver profile** authentication method. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-Database-Native/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * Database native [ Database native ](./) Table of contents * Settings * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Settings 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Database authentication models # Database native DBeaver includes support for Database Native authentication, enabling secure connections to your databases. ![](../images/auth_methods/Database_Native/database-native-authentication- configuration.png) ## Settings¶ Here are the steps to configure Database Native authentication: 1. From the **Authentication** dropdown menu, select the **Database Native** method. 2. Enter the username and password that are associated with your database in the **Username** and **Password** fields respectively. Tip If you check the **Save credentials locally** option, you will not be asked to input your credentials every time you connect. 3. Once you have input your credentials, click the **Test Connection** button to verify your settings. If everything is configured correctly, DBeaver should now be able to connect to your database using the Database Native authentication method. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-Databricks/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * Databricks authentication [ Databricks authentication ](./) Table of contents * OAuth authentication * Machine to Machine * User to Machine * Personal Access Token * Other authentication methods * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * OAuth authentication * Machine to Machine * User to Machine * Personal Access Token * Other authentication methods 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Databricks # Databricks authentication Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver is fully compatible with the Databricks OAuth and Personal Access Token (PAT) authentication methods, offering you secure ways to access your [Databricks](../Database-driver-Databricks/) databases. The following methods can be configured directly in the connection settings: ## OAuth authentication¶ 1. From the **Authentication** dropdown menu, select **OAuth**. 2. Depending on your use case, choose one of the following modes: * Machine to Machine \- for service-to-service authentication * User to Machine \- for interactive user login 3. Enter the required connection details. 4. Click the **Test Connection** button to verify your settings. If configured correctly, DBeaver will establish a connection using the Databricks OAuth authentication method. ### Machine to Machine¶ Use this method for automated service-to-service authentication. The access token is obtained programmatically using application credentials, so no manual user login is required at connection time. You need to provide the [HTTP Path](https://docs.databricks.com/aws/en/integrations/compute-details) of your Databricks SQL endpoint, **Client ID** and **Client Secret** for the application. ![](../images/database/databricks/oauth-machine-to-machine.png) Info For details, see [OAuth machine-to- machine](https://docs.databricks.com/aws/en/dev-tools/auth/oauth-m2m) ### User to Machine¶ Use this method when authentication must happen on behalf of a specific user. You need to provide the [HTTP Path](https://docs.databricks.com/aws/en/integrations/compute-details) of your Databricks SQL endpoint. No client credentials are required, the connection will open a browser window for login. ![](../images/database/databricks/oauth-user-to-machine.png) Info For details, see [OAuth user-to- machine](https://docs.databricks.com/aws/en/dev-tools/auth/oauth-u2m) ## Personal Access Token¶ Use this method for direct authentication with a personal token generated in the Databricks workspace. Follow these steps to configure Databricks Personal Access Token authentication: 1. From the **Authentication** dropdown menu, select **Personal Access Token**. ![](../images/database/databricks/personal-access-token.png) 2. Enter the [HTTP Path](https://docs.databricks.com/aws/en/integrations/compute-details) of your Databricks SQL endpoint. 3. Paste your **Personal Access Token** into the corresponding field. You can generate a token in the Databricks workspace under **User Settings → Access tokens**. 4. Click the **Test Connection** button to verify your settings. If configured correctly, DBeaver will establish a connection using the Databricks OAuth authentication method. Info For details, see [Databricks - Personal access tokens](https://docs.databricks.com/aws/en/dev-tools/auth/pat) ## Other authentication methods¶ Besides OAuth and Personal Access Token, you can also use: * [Native Database authentication](../Authentication-Database-Native/) * [DBeaver Profile authentication](../Authentication-DBeaver-profile/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-LDAP-Mechanism/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * LDAP authentication in Teradata [ LDAP authentication in Teradata ](./) Table of contents * Settings * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Settings 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. Teradata # LDAP authentication in Teradata DBeaver includes support for LDAP Mechanism authentication, an additional secure method to connect to your [Teradata](../Database-driver-Teradata/) databases. ![](../images/auth_methods/LDAP_Mechanism/database-ldap-mechanism- authentication-configuration.png) ## Settings¶ To configure LDAP Mechanism authentication in DBeaver, follow these steps: 1. From the **Authentication** dropdown menu, select the **LDAP Mechanism** method. 2. In the **Username** and **Password** fields, enter the credentials associated with your LDAP server. 3. Enter the necessary additional information in the **LDAP Extra DATA** field. This might be specific configurations or parameters required by your LDAP server. Consult with your system administrator or refer to [Teradata's LDAP documentation](https://docs.teradata.com/r/Teradata-Warehouse-Miner-Model-Manager-User-Guide/November-2017/Software-Requirements/Database-Connections-Using-LDAP) for the exact details. Tip Selecting the **Save credentials locally** option means you will not have to input your credentials every time you connect. 4. After entering your credentials and extra data, click the **Test Connection** button. If all settings are correctly configured, DBeaver will connect to your database using the LDAP Mechanism authentication method. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-Microsoft-Entra-ID/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * Microsoft Entra ID [ Microsoft Entra ID ](./) Table of contents * Prerequisites * Microsoft Entra ID configuration * Configure an authentication type * Default credentials * Environment variables * macOS * Linux * Windows * Enterprise application * Client secret * Client certificate * Troubleshooting * Authentication fails * Group-based authentication fails * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Prerequisites * Microsoft Entra ID configuration * Configure an authentication type * Default credentials * Environment variables * macOS * Linux * Windows * Enterprise application * Client secret * Client certificate * Troubleshooting * Authentication fails * Group-based authentication fails 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Database authentication models # Microsoft Entra ID Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver comes with Microsoft Entra ID (formerly Azure AD) authentication support, allowing secure access to your databases. Info The official [Entra documentation](https://learn.microsoft.com/en-us/entra/). ## Prerequisites¶ Make sure you have: * an active Azure account with the appropriate permissions * a Microsoft Entra ID application is registered and configured by your administrator. Info For more details on permissions, see [Azure permissions](../Azure- Permissions/). ### Microsoft Entra ID configuration¶ To enable authorization with the Microsoft platform, you need a registered application in Azure. If one doesn't exist, create and configure it as follows: 1. **Register an application** Create a new enterprise application in Microsoft Entra by following the steps in the [official Microsoft documentation](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate#register-an-application). 2. **Configure application secrets** DBeaver uses the OpenID Connect protocol for authorization with Microsoft Entra ID. To enable this, configure application secrets. Detailed instructions are available in the [official Microsoft documentation](https://learn.microsoft.com/en-us/entra/identity-platform/security-best-practices-for-app-registration). Important Record the value of the client secret immediately after creating it. It can only be viewed once. If you miss this step, you’ll need to create a new secret. ## Configure an authentication type¶ ### Default credentials¶ Use this when you do not want to store secrets in DBeaver. ![](../images/auth_methods/Entra_ID/entra-id-authentication-default- credentials.png) 1. Open **Edit connection**. 2. On **Connection settings** , set **Credentials** to **Default credentials**. 3. (Optional) If database access is granted through an Entra ID group, enter the **AD Group name**. 4. (Optional) Review **Use legacy token permissions**. * keep it unchecked in almost all cases * enable it only if your DBA or admin specifically instructs you Info This option forces the connection to use older token scopes and claim formats for backward compatibility with databases or drivers that don’t fully support modern Microsoft Entra ID permissions. 5. Click **Test connection** , then **Save**. Tip To see how DefaultAzureCredential picks a provider, see [DefaultAzureCredential overview](https://learn.microsoft.com/en- us/azure/developer/java/sdk/authentication/credential- chains#defaultazurecredential-overview). #### Environment variables¶ Set these **before** starting DBeaver if you want to guide how the SDK gets a token. * **If you use the environment-variable credential** * `AZURE_CLIENT_ID` — your app’s client ID * `AZURE_TENANT_ID` — your Microsoft Entra directory (tenant) ID * then either: * `AZURE_CLIENT_SECRET`, or * `AZURE_CLIENT_CERTIFICATE_PATH` and `AZURE_CLIENT_CERTIFICATE_PASSWORD` (optional, for `.pfx`) * **If you use managed identity** * for a **user-assigned** identity: `AZURE_CLIENT_ID` * for a **system-assigned** identity: no variables are required * _(available only in Azure environments like VM, App Service, or Function App)_ ##### macOS¶ launchctl setenv AZURE_CLIENT_ID launchctl setenv AZURE_TENANT_ID # optional launchctl setenv AZURE_CLIENT_SECRET launchctl setenv AZURE_CLIENT_CERTIFICATE_PATH /path/to/cert.pfx launchctl setenv AZURE_CLIENT_CERTIFICATE_PASSWORD Tip Restart DBeaver (or log out and back in) after running these commands. Variables set with `launchctl` are visible only to new GUI apps. ##### Linux¶ export AZURE_CLIENT_ID= export AZURE_TENANT_ID= # optional export AZURE_CLIENT_SECRET= export AZURE_CLIENT_CERTIFICATE_PATH=/path/to/cert.pfx export AZURE_CLIENT_CERTIFICATE_PASSWORD= Tip These variables work only in the current terminal session. Add them to `~/.bashrc` or `~/.profile` to make them persistent when is launched from the desktop. ##### Windows¶ Set variables as **User variables** in **System Properties - Environment Variables** , then restart DBeaver. Or set them from PowerShell: setx AZURE_CLIENT_ID "" setx AZURE_TENANT_ID "" # optional setx AZURE_CLIENT_SECRET "" setx AZURE_CLIENT_CERTIFICATE_PATH "C:\path\to\cert.pfx" setx AZURE_CLIENT_CERTIFICATE_PASSWORD "" ### Enterprise application¶ Use this for user sign-in without storing a secret in DBeaver. ![](../images/auth_methods/Entra_ID/entra-id-authentication-enterprise- application.png) 1. Open **Edit connection**. 2. Set **Credentials** to **Enterprise application**. 3. Enter the values below: Field in DBeaver | What to enter | Where to find in the Azure portal | Reference ---|---|---|--- **Client ID** | Your application’s **Application (client) ID** | Microsoft Entra ID - App registrations - **Your app** \- **Overview** | [Copy the application ID (client ID)](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app#copy-the-application-id-client-id) **Tenant ID** | Your **Directory (tenant) ID** | Microsoft Entra ID - **Overview** \- **Tenant ID** | [Find your tenant ID](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-find-tenant) **AD Group name** (Optional) | The exact Entra **group name** that was granted database access | Microsoft Entra ID - **Groups** \- **Your group** \- **Overview** | [Create a group and add members](https://learn.microsoft.com/en-us/entra/fundamentals/quickstart-create-group-add-members) 4. (Optional) Review **Use legacy token permissions**. * keep it unchecked in almost all cases * enable it only if your DBA or admin specifically instructs you Info This option forces the connection to use older token scopes and claim formats for backward compatibility with databases or drivers that don’t fully support modern Microsoft Entra ID permissions. 5. Click **Test connection** , then **Save**. Info For information on creating the application in Azure, see [Register an app](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart- register-app). ### Client secret¶ Use this for service connections where an app authenticates with a secret. ![](../images/auth_methods/Entra_ID/entra-id-authentication-client-secret.png) 1. Open **Edit connection**. 2. Set **Credentials** to **Client secret**. 3. Enter the values below: Field in DBeaver | What to enter | Where to find in the Azure portal | Reference ---|---|---|--- **Client ID** | Your app’s **Application (client) ID** | Microsoft Entra ID - **App registrations** \- **Your app** \- **Overview** | [Copy the client ID](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app#copy-the-application-id-client-id) **Tenant ID** | Your **Directory (tenant) ID** | Microsoft Entra ID - **Overview** \- **Tenant ID** | [Find your tenant ID](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-find-tenant) **Client secret** | The secret **Value** (not the Secret ID) | **Your app** \- **Certificates & secrets** \- **Client secrets** | [Add a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/how-to-add-credentials?tabs=client-secret) **AD Group name** (Optional) | The exact Entra **group name** that was granted database access | Microsoft Entra ID - **Groups** \- **Your group** \- **Overview** | [Create a group and add members](https://learn.microsoft.com/en-us/entra/fundamentals/quickstart-create-group-add-members) 4. (Optional) Review **Use legacy token permissions**. * keep it unchecked in almost all cases * enable it only if your DBA or admin specifically instructs you Info This option forces the connection to use older token scopes and claim formats for backward compatibility with databases or drivers that don’t fully support modern Microsoft Entra ID permissions. 5. Click **Test connection** , then **Save**. Info For information on creating the secret in Azure, see [Add a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/how-to-add- credentials?tabs=client-secret). ### Client certificate¶ Use this when your org prefers certificates to secrets. ![](../images/auth_methods/Entra_ID/entra-id-authentication-client- certificate.png) 1. Open **Edit connection**. 2. Set **Credentials** to **Client certificate**. 3. Enter the values below: Field in DBeaver | What to enter | Where to find in the Azure portal | Reference ---|---|---|--- **Client ID** | Your app’s **Application (client) ID** | Microsoft Entra ID - **App registrations** \- **Your app** \- **Overview** | [Copy the client ID](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app#copy-the-application-id-client-id) **Tenant ID** | Your **Directory (tenant) ID** | Microsoft Entra ID - **Overview** \- **Tenant ID** | [Find your tenant ID](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-find-tenant) **Client certificate path** | Local path to the private-key file | You generate the cert locally and upload the **public** cert to **Your app** \- **Certificates & secrets** \- **Certificates** | [Certificate credentials](https://learn.microsoft.com/en-us/entra/identity-platform/certificate-credentials) **Client certificate password** (Optional) | Password for the `.pfx`, if set when exporting | Set during export of the `.pfx` on your machine | [Certificate credentials](https://learn.microsoft.com/en-us/entra/identity-platform/certificate-credentials) **AD Group name** (Optional) | Exact **group name** that has database access | Microsoft Entra ID - **Groups** \- **Your group** \- **Overview** | [Create a group and add members](https://learn.microsoft.com/en-us/entra/fundamentals/quickstart-create-group-add-members) 4. (Optional) Review **Use legacy token permissions**. * keep it unchecked in almost all cases * enable it only if your DBA or admin specifically instructs you Info This option forces the connection to use older token scopes and claim formats for backward compatibility with databases or drivers that don’t fully support modern Microsoft Entra ID permissions. 5. Click **Test connection** , then **Save**. Info For information on certificate credentials in Azure, see [Certificate credentials](https://learn.microsoft.com/en-us/entra/identity- platform/certificate-credentials). ## Troubleshooting¶ ### Authentication fails¶ * Check that the **Client ID** and **Tenant ID** match the [registered application in Azure](https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-add-app-roles-in-azure-ad-apps#find-the-application-id-and-directory-tenant-id). * Make sure the user is assigned in the [Azure portal](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/assign-user-or-group-access-portal). * Confirm the app has the required [API permissions or roles](https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent). * Make sure required [tenant-wide admin consent](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/grant-admin-consent) was granted by the user or an admin. ### Group-based authentication fails¶ If you're using an Entra ID security group to connect to Azure Database for PostgreSQL and see an error like: password authentication failed for user "" Check the following: * The Entra ID user is a [member of the group](https://learn.microsoft.com/en-us/entra/fundamentals/quickstart-create-group-add-members). * The group has [database access granted in PostgreSQL](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-configure-sign-in-azure-ad-authentication#grant-database-access). * You’re using an authentication method that supports Entra ID tokens (like **Default credentials** or **Enterprise application**). * The access token includes group claims, and the [required API permissions were granted by an admin](https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent). * Enter the group name in the **AD Group name** field of the connection settings in DBeaver. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-MongoDB/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * MongoDB authentication [ MongoDB authentication ](./) Table of contents * Settings * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Settings 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. MongoDB # MongoDB authentication Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver is fully compatible with the MongoDB authentication method, offering you a secure way to access your [MongoDB](../MongoDB/) databases. ![](../images/auth_methods/MongoDB/mongodb-authentication-configuration.png) ## Settings¶ Here are the steps to configure MongoDB authentication: 1. From the **Authentication** dropdown menu, select the **MongoDB authentication** method. 2. From the **Mechanism** dropdown menu, select an option. The following table outlines the available authentication mechanisms: Mechanism | Description ---|--- **SCRAM-SHA-1** | A password-based authentication mechanism using SHA-1 hashing algorithm. Suitable for securing data transmissions. **SCRAM-SHA-256** | An upgraded version of `SCRAM-SHA-1`, using the stronger `SHA-256` hashing algorithm. Offers enhanced security. **MONGODB-CR** | A protocol specific to MongoDB, utilizing a challenge-response mechanism for authentication. **PLAIN** | A simple, unencrypted password-based authentication mechanism. Not recommended for production environments due to security vulnerabilities. **GSSAPI** | Based on the Kerberos protocol, this mechanism offers secure password authentication. **MONGODB-X509** | A certificate-based authentication mechanism that validates the client's `X.509` certificates. **NONE** | No authentication is required. This method should only be used in secure, isolated environments. You can read more about these mechanisms on the [MongoDB documentation](https://www.mongodb.com/docs/drivers/go/current/fundamentals/auth/) page. 3. Fill in the **Source** field if necessary. 4. Enter the username and password in the **Username** and **Password** fields respectively. Tip If you check the **Save credentials locally** option, you will not be asked to input your credentials every time you connect. 5. Once you have input your credentials, click the **Test Connection** button to verify your settings. If everything is configured correctly, DBeaver should now be able to connect to your database using the MongoDB authentication method. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-PostgreSQL-Pgpass/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * PgPass authentication [ PgPass authentication ](./) Table of contents * Settings * Override host * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Settings * Override host 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. PostgreSQL # PgPass authentication DBeaver is fully compatible with the PgPass authentication method, offering you a secure way to access your [PostgreSQL](../Database-driver-PostgreSQL/) databases. ![](../images/auth_methods/PgPass/pgpass-authentication-configuration.png) ## Settings¶ PostgreSQL PgPass method allows you to authenticate using credentials stored in a `.pgpass` file. Here are the steps to configure this: 1. From the **Authentication** dropdown menu, select the **PostgreSQL Pgpass** method. 2. Enter the username that is associated with the database in the **Username** field. 3. DBeaver will use the `.pgpass` file for authentication. If you haven't created this file yet, follow the official [PostgreSQL documentation](https://www.postgresql.org/docs/current/libpq-pgpass.html) to create it, format it correctly, and understand where it should be located on your system. Note Ensure that the permissions for your `.pgpass` file are set correctly. The file should only be readable and writable by the file owner. Improper permissions can lead to security issues. 4. Once your `.pgpass` file is set up as per the PostgreSQL documentation, you can test the connection from within the **Test Connection** button. If everything is configured correctly, DBeaver should now be able to connect to your PostgreSQL database using the PgPass authentication method. ### Override host¶ DBeaver gives you the option to override the default host. If you wish to do this, select the checkbox next to **Override host** and then input the new host information in the field that appears. Tip This is useful in situations where you need to connect to a different server without changing the `.pgpass` file, or if the `.pgpass` file is shared among several users or applications with different host requirements. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-PostgreSQL-SSPI/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * SSPI (Windows SSO) [ SSPI (Windows SSO) ](./) Table of contents * Settings * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Settings 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. PostgreSQL # SSPI (Windows SSO) Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver comes with SSPI (Security Support Provider Interface) authentication support, allowing secure access to [PostgreSQL](../Database-driver- PostgreSQL/) databases. This authentication type enables Windows Single Sign- On (SSO), allowing users to authenticate using their existing Windows account credentials. ![](../images/auth_methods/SSPI/sspi-authentication-configuration.png) ## Settings¶ To configure SSPI authentication in DBeaver, follow these steps: 1. From the **Authentication** dropdown menu, select the **PostgreSQL SSPI** method. 2. For the authentication process, your system will utilize the relevant credentials automatically. On Windows systems, your current login credentials are used, and on non-Windows platforms that support GSSAPI, the integrated authentication system will apply. Note Your system (whether it's Windows or a non-Windows platform with GSSAPI support), and PostgreSQL server must be correctly configured for SSPI authentication. If you encounter any issues during this process, please follow the official [PostgreSQL documentation](https://www.postgresql.org/docs/current/sspi-auth.html). 3. Click **Test Connection** to confirm your settings. If the test is successful, your setup is complete. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-Salesforce/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * Salesforce authentication [ Salesforce authentication ](./) Table of contents * Password authentication * OAuth authentication * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Password authentication * OAuth authentication 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. Salesforce # Salesforce authentication Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver is fully compatible with the Salesforce password and OAuth authentication methods, offering you a secure ways to access your [Salesforce](../Database-driver-Salesforce/) databases. ## Password authentication¶ Here are the steps to configure Salesforce authentication: 1. From the **Authentication** dropdown menu, select the **Salesforce password authentication** method. ![](../images/auth_methods/Salesforce/salesforce-password-authentication- configuration.png) 2. Enter the username, password and security token that are associated with your Salesforce database in the **Username** , **Password** and **Security token** fields respectively. Note Having a security token is necessary for securely connecting to Salesforce from DBeaver. This token can be generated in your Salesforce account settings. 3. Once you have input your credentials, click the **Test Connection** button to verify your settings. If everything is configured correctly, DBeaver should now be able to connect to your database using the Salesforce authentication method. Tip If you check the **Save credentials locally** option, you will not be asked to input your credentials every time you connect. ## OAuth authentication¶ Follow these steps to configure Salesforce OAuth authentication: 1. From the **Authentication** dropdown menu, select **Salesforce OAuth authentication**. ![](../images/auth_methods/Salesforce/salesforce-oauth-authentication- configuration.png) 2. Enter the **Client ID** and **Client Secret** associated with your Salesforce application in their respective fields. Tip The **Client Secret** field is optional, but entering it will allow a more secure connection to your Salesforce account. 3. In the **OAuth flow type** field, choose the authorization flow: * **Web Server Flow** \- uses a browser-based login and authorization prompt for user-level access. * **Client Credentials Flow** \- uses application-level credentials for server-to-server authentication (no user interaction required). Info For setup steps, see [Salesforce Client Credentials Flow documentation](https://help.salesforce.com/s/articleView?id=xcloud.remoteaccess_oauth_client_credentials_flow.htm&type=5). 4. Click the **Test Connection** button to verify your settings. If configured correctly, DBeaver will establish a connection using the Salesforce OAuth authentication method. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Authentication-Snowflake/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * Snowflake authentication [ Snowflake authentication ](./) Table of contents * Database native authentication * SSO authentication * Private key authentication * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Database native authentication * SSO authentication * Private key authentication 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Snowflake # Snowflake authentication DBeaver supports Snowflake's password, SSO ![](../images/commercial.png), and private key ![](../images/commercial.png) authentication methods, giving you secure access to your [Snowflake](../Snowflake/) databases. Info For more details on Snowflake authentication, see [Snowflake documentation](https://docs.snowflake.com/en/user-guide). ## Database native authentication¶ To connect using your Snowflake username and password: 1. In the **Authentication** list, select **Database native**. 2. Enter your Snowflake **Username** and **Password**. 3. (Optional) Enter a **Role** if you use role-based access control (RBAC). 4. (Optional) In **Authenticator** , choose the authenticator name (default is `snowflake`). Tip Use `externalbrowser` for SSO-based login. 5. Click the **Test Connection** button to verify your settings. ## SSO authentication¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To connect using Snowflake SSO: 1. In the **Authentication** list, select **SSO (Browser)**. 2. Enter your Snowflake **Username**. 3. (Optional) Enter a **Role** if you use RBAC. 4. Click the **Test Connection** button to verify your settings. ## Private key authentication¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. To connect using a private key: 1. In the **Authentication** list, select **Private key**. 2. Enter your Snowflake **Username**. 3. Upload your **Private key** file or paste the key. 4. Enter the **Key password** for your private key. 5. (Optional) Enter a **Role** if you use RBAC. 6. Click the **Test Connection** button to verify your settings. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Automation-Security/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * Automation (console) security [ Automation (console) security ](./) Table of contents * Configuration options * Environment variable * Password file * Removing automation security * Remove the environment variable * Delete the password file * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configuration options * Environment variable * Password file * Removing automation security * Remove the environment variable * Delete the password file 1. [DBeaver](/docs/dbeaver) 2. [Security](/docs/dbeaver/Security-in-DBeaver-PRO) 3. Password secure storage # Automation (console) security Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. Automation security in DBeaver allows [scheduled tasks](../Task-Scheduler/) to run without manual password entry. This is useful for automating processes such as sending emails or executing database queries in the background. To use automation security: 1. Navigate to **Window - > Preferences -> General -> Security**. 2. Under **Encryption Method** , select **Automation (console)**. 3. Click **Apply and Close** to save the changes. 4. Configure password storage – Use environment variables or a password file to provide credentials. Warning Automation security is less secure, as local credentials can be decrypted by anyone with access to the machine. Only enable it on controlled machines where task execution is critical. ## Configuration options¶ You can provide a password in one of the following ways: ### Environment variable¶ Store the password in memory by setting the `DBEAVER_MASTER_PASSWORD` environment variable. To configure: 1. Open a terminal or command prompt. 2. Set the environment variable: 3. On Windows (PowerShell): $env:DBEAVER_MASTER_PASSWORD="your_password" 4. On macOS/Linux: export DBEAVER_MASTER_PASSWORD="your_password" ### Password file¶ Store the password in a file and reference it using `DBEAVER_MASTER_PASSWORD_PATH`. To configure: 1. Create a text file containing the password. echo "your_password" > /path/to/password_file 2. Set the environment variable to point to the file: 3. On Windows (PowerShell): $env:DBEAVER_MASTER_PASSWORD_PATH="C:\path\to\password_file" 4. On macOS/Linux: export DBEAVER_MASTER_PASSWORD_PATH="/path/to/password_file" 5. Ensure the password file has restricted permissions: chmod 600 /path/to/password_file ## Removing automation security¶ To remove stored automation security credentials, follow these steps: ### Remove the environment variable¶ If you stored the password using an environment variable, delete it: * On Windows (PowerShell): Remove-Item Env:DBEAVER_MASTER_PASSWORD * On macOS/Linux: unset DBEAVER_MASTER_PASSWORD ### Delete the password file¶ If you stored the password in a file, delete it securely: * On Windows: Remove-Item "C:\path\to\password_file" * On macOS/Linux: rm -f /path/to/password_file After removing automation security, restart DBeaver to apply the changes. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Azure-Cloud-Explorer/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * Azure cloud explorer [ Azure cloud explorer ](./) Table of contents * Connection setup * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Connection setup 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. Cloud explorer # Azure cloud explorer Note This feature is available in [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver offers enhanced capabilities for managing and connecting to Azure databases directly from the DBeaver interface. The processes for creating and modifying connections are comprehensively detailed in the [Cloud Explorer](../Cloud-Explorer/) article. This guide explains the essential steps to connect to an Azure database using DBeaver. ## Connection setup¶ 1. Click on the Cloud Explorer button ![](../images/ug/cloud-explorer/cloud-explorer-button.png) or navigate to **Database** -> **Cloud Explorer** in the menu. 2. Navigate to the **Microsoft Azure** section, choose the authentication type and enter your credentials. For detailed information on authentication, see [Authentication Microsoft Entra ID](../Authentication-Microsoft-Entra-ID/). ![](../images/ug/cloud-explorer/azure-cloud-configuration.png) Info To use [Azure Storage](../Cloud-Storage/), you must fill in the **Account ID** and **Access Key** fields in the **Storage account** section. 3. Click on **Apply and Close**. This action will save your input and close the settings window. 4. Once you have completed the previous step, you will notice **Azure configuration** appear in your configurations. This means you have successfully set up your **Client_id** , and Azure recognizes your application. ![](../images/ug/cloud-explorer/azure-cloud-services.png) 5. Select the database you want to connect to within the drop-down menu. This action initiates the process of connecting your selected database to DBeaver. 6. You will be redirected to the Microsoft authentication page. Here, you need to enter your login details. 7. After successful authentication, return to DBeaver to continue working with your connected database. Info See [troubleshooting](../Authentication-Microsoft-Entra-ID/#troubleshooting) for common authentication issues. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Azure-Permissions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * Azure permissions [ Azure permissions ](./) Table of contents * Required permissions * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Required permissions 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. [Cloud connection settings](/docs/dbeaver/AWS-Permissions) 4. Azure # Azure permissions To use DBeaver with Azure, you need to configure certain permissions in Microsoft Entra ID. These permissions are required for specific actions, like logging in, browsing resources, or provisioning users. Info Learn more about [permissions](https://learn.microsoft.com/en- us/sql/relational-databases/security/authentication-access/getting-started- with-database-engine-permissions?view=sql-server-ver16) in the official Entra documentation. ## Required permissions¶ Action | Permission | Description ---|---|--- **Login** | No additional permissions required | Allows users to authenticate in DBeaver. **Cloud Explorer** | `Azure Service Management` (user_impersonation) | Grants access to retrieve a list of available user resources using the `https://management.azure.com//.default` scope. **Database authentication - Azure SQL, MySQL** | `Azure SQL Database` (user_impersonation) | Enables database authentication (Azure SQL, MySQL) using the `https://database.windows.net//.default` scope. **Database authentication - PostgreSQL, MySQL** | `Azure OSSRDBMS Database` (user_impersonation) | Enables database authentication (PostgreSQL, MySQL) using the `https://ossrdbms-aad.database.windows.net/.default` scope. **User provisioning** | `User.ReadBasic.All` or `User.Read.All` | Allows importing users from Azure AD. **Auto-assigned user teams** | No additional permissions required, but `groups` claim must be included in the access or ID token. | Automatically assigns users to teams based on their Azure AD group memberships. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Background-Tasks/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * Background tasks [ Background tasks ](./) Table of contents * Opening the Background Tasks View * Utilizing the Background Tasks View * Task management * Canceling a Task * Removing all finished operations * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Opening the Background Tasks View * Utilizing the Background Tasks View * Task management * Canceling a Task * Removing all finished operations 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Background tasks Background tasks in DBeaver are operations that run behind the scenes, allowing you to continue working without disruption. These tasks can involve a range of operations, such as [data transfer](../Data-transfer/) and [SQL script execution](../SQL-Execution/), amongst others. ## Opening the Background Tasks View¶ You can open the **Background Tasks** view from the main menu by clicking **Window** -> **Show View** -> **Other**. In the **Show View** window, click **Background Tasks** , and then click **Open** : ![](../images/ug/Background-tasks-open.png) Tip You can also open the Background Tasks view from other views or editors. For example, in the [Search](../Search-Tool/) view, when a search takes time, a button ![](../images/ug/Show-progress-button.png) appears in the bottom-right corner. Click it to open the Background Tasks view. ## Utilizing the Background Tasks View¶ The **Background Tasks** view comprehensively displays the progress of background tasks like **Search** and **SQL query execution**. It becomes beneficial when you want to monitor the progress of time-consuming operations. The view displays detailed data when background tasks consume a noticeable amount of time. ![](../images/ug/Background-tasks-view.png) ## Task management¶ ### Canceling a Task¶ If you need to cancel a task in progress, it is possible to do so directly from the Background Tasks view. Click the **Cancel Operation** button ![](../images/ug/Cancel-Search-active.png) to stop the ongoing task immediately, freeing up resources for other operations. ### Removing all finished operations¶ In the Background Tasks view, DBeaver also provides an option to remove all finished operations from the list to declutter the view and focus on ongoing tasks. To use this feature, click the **Remove all finished operations** button ![](../images/ug/remove-all-finished-operations-button.png). It helps in maintaining a neat and organized task view, enabling you to manage your current tasks without distractions from completed operations. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Backup-Restore/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * Backup and restore [ Backup and restore ](./) Table of contents * Database specific settings * MySQL * Backup MySQL database * Restore MySQL database * PostgreSQL * Backup PostgreSQL database * Global PostgreSQL database backup * Restore PostgreSQL database * Additional features * Execute Script Command * Extra command arguments * Dump and restore operations as tasks * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Database specific settings * MySQL * Backup MySQL database * Restore MySQL database * PostgreSQL * Backup PostgreSQL database * Global PostgreSQL database backup * Restore PostgreSQL database * Additional features * Execute Script Command * Extra command arguments * Dump and restore operations as tasks 1. [DBeaver](/docs/dbeaver) 2. Data transfer and schema compare # Backup and restore Note This feature is available in Community, [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. This article provides an in-depth guide to the Backup and Restore features available in DBeaver. DBeaver supports a wide range of databases for backup and restore operations: **Classic databases** | **Cloud databases** ---|--- CrateDB | [AlloyDB](../Database-driver-AlloyDB-for-PostgreSQL/) [Greenplum](../Database-driver-Greenplum/) | [Google Cloud SQL for MySQL](../Database-driver-MySQL-on-Google-Cloud/) [MariaDB](../Database-driver-MariaDB/) | [Google Cloud SQL for PostgreSQL](../Database-driver-PostgreSQL-on-Google-Cloud/) Materialize | [MySQL](../Database-driver-MySQL/) | [PostgreSQL](../Database-driver-PostgreSQL/) | SingleStore | TiDB | TimescaleDB | [Yellowbrick](../Database-driver-Yellowbrick/) | YugabyteDB | EnterpriseDB | The native backup and restore differs from the standard DBeaver [Data Transfer](../Data-transfer/) feature by focusing on creating and applying database backups using specialized utilities. These tools are tailored for high-performance interactions with databases, potentially accelerating the backup and restore processes compared to general data transfer methods. These functions can be accessed from the Context Menu's **Tools** or the Main Menu's **Database** -> **Tools**. ## Database specific settings¶ Different database systems possess distinct settings for backup and restore processes. This section presents the settings specific to MySQL and PostgreSQL. ### MySQL¶ #### Backup MySQL database¶ To initiate a backup: 1. Select the desired database. 2. Right-click on the database and choose **Tools** -> **Dump database**. 3. The **Dump** window will appear. Select the necessary objects and click **Next**. 4. The **Export configuration** tab will be displayed. Here you can find the following checkboxes and fields: ![](../images/ug/tools/backup-restore/mysql-dump-window.png) Option/Field | Description ---|--- **Execution Method** | Method for execution. The default is **Normal (no locks)**. **Execution Method** options: | **Normal (no locks)** : This is the default method. It performs the dump without acquiring any locks on the tables. Suitable for databases where minimal disruption is required during the dump process. | **Online backup in single transaction** : This method ensures the consistency of the database by performing the dump within a single transaction. It's ideal for databases that support transactional storage engines like InnoDB. The backup occurs without interrupting other database operations but requires a higher isolation level. | **Lock all tables** : As the name suggests, this method locks all tables in the database during the dump process. It ensures complete consistency of the dump but may interrupt other database operations. Suitable for databases or situations where you want a consistent snapshot and are okay with potential disruptions. **No CREATE statements** | Do not include `CREATE` statements in the dump. **Compressed** | Include the `--compress` flag to enable network compression during dump. **Add DROP statements** | Include `DROP` statements before CREATE statements. **Disable keys** | Disable keys during the dump process. **Extended inserts** | Use extended `INSERT` statements in the dump. **Dump events** | Include events in the dump. **Additional comments** | Include comments in the dump. **Remove DEFINER** | Remove `DEFINER` clause from the dump. **Dump binaries in hex** | Display binary data as `HEX` in the dump. **Structure only** | Only dump table structures, not data. **Output folder** | Specify the directory where the dump file will be saved. For Ultimate Edition, Team Edition, and CloudBeaver versions, users have the option to save to a remote file system using the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png). **Extra command args** | Provide additional command-line arguments. See details in the Extra command arguments section. **Authenticate** | Click to open the **Authentication** window where you can fill in the Username/Password for override. **Reset to default** | Reset credentials to their default values. **Override host credentials** | Use different host credentials, if necessary. **Local Client** | Open a window to specify the path to the Local client. [More about setting it up](../Local-Client-Configuration/). Note The particular set of configuration options depends on the database type. 5. After configuring the settings, click **Start**. 6. Upon successful completion, a notification will appear with information about the process. 7. The backup file can be found in the folder specified during the **Export configuration** step. #### Restore MySQL database¶ To initiate a restore: 1. Select the desired database. 2. Right-click on the database and choose **Tools** -> **Restore database**. 3. The **Restore** window will appear. In this window you have to provide the path to the SQL file you wish to restore from in the designated field. Example path: `/path/to/file.sql` ![](../images/ug/tools/backup-restore/mysql-restore-window.png) Below are the settings for the restore process: Setting Name | Description ---|--- **Log Level** | Choose the level of logging for the restore process. **Log Level** options: | **Normal** : Provides standard logging information. It captures the essential details of the restore process, ensuring that the logs remain concise and focused on primary events. | **Verbose** : Gives more detailed logging information than the Normal level. It includes additional context and information, making it suitable for situations where you want to understand the process more in-depth without getting into debugging details. | **Debug** : Offers the most detailed logging information. It captures all events, including low-level operations and potential issues. This level is ideal for troubleshooting problems or understanding the inner workings of the restore process. **Extra command args** | Provide additional command-line arguments. See details in the Extra command arguments section. **Disable foreign key checks** | Disable foreign key checks during the restore process. **Authenticate** | Click to open the **Authentication** window where you can fill in the Username/Password for override. **Reset to default** | Reset credentials to their default values. **Override host credentials** | Use different host credentials, if necessary. **Local Client** | Specify the path to the Local client. Tip In the input field for specifying the path to the SQL file, you can choose a file from a local directory or use the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png) to select a file from a remote file system. This functionality is accessible to users of the Ultimate Edition, Team Edition, and CloudBeaver. 4. After configuring the settings, click **Start**. 5. Upon successful completion, a notification will appear with information about the process. ### PostgreSQL¶ #### Backup PostgreSQL database¶ To initiate a backup: 1. Select the desired database. 2. Right-click on the database and choose **Tools** -> **Backup**. 3. The **Dump** window will appear. Select the necessary objects and click **Next**. ![](../images/ug/tools/backup-restore/postgresql-dump-choose-objects- window.png) Note By default, when all schemas are selected, DBeaver enables the **Complete backup** checkbox and skips `-n` flags in the `pg_dump` command to include all database objects. Clear the checkbox to add `-n` for each selected schema and back up only those. For details, see the [`pg_dump` \--schema documentation](https://www.postgresql.org/docs/current/app-pgdump.html#APP- PGDUMP-OPTIONS). 4. The **Backup settings** tab will be displayed. Here you can find the following checkboxes and fields: ![](../images/ug/tools/backup-restore/postgresql-dump-window.png) Setting | Description ---|--- **Format** | Choose the format for the dump. Options include Directory, Tar, Custom, and Plain. **Format** options: | **Directory** : Splits the output into one file per table. Suitable for larger databases as it facilitates parallel restoration. | **Tar** : Produces archive in tar format. Useful for backups since it can be read by standard tools. | **Custom** : A flexible format that allows selective restore and other operations. | **Plain** : Produces plain-text SQL script file. It can be used with psql for restoring. **Compression** | Set the compression level for the dump, ranging from 0 (no compression) to 9 (maximum compression). **Encoding** | Select the character encoding for the dump. The available encodings depend on database configuration and locale. **Use SQL INSERT instead of COPY for rows** | Use the `INSERT` command instead of the `COPY` command for row data. **Do not backup privileges (GRANT/REVOKE)** | Exclude privilege commands (`GRANT`/`REVOKE`) from the dump. **Discard objects owner** | Exclude the ownership information from the dump. **Add drop database statement** | Include a statement in the dump to drop the database before restoring. **Add create database statement** | Include a statement in the dump to create the database when restoring. **Output folder** | Specify the directory where the dump file will be saved. For Ultimate Edition, Team Edition, and CloudBeaver versions, users have the option to save to a remote file system using the **Browser remote file system** ![](../images/dt/Browser-remote-file-system-button.png) button. **File name pattern** | Define the naming pattern for the dump file, with variables like `${database}` and `${timestamp}` to customize the filename. **Extra command args** | Provide additional command-line arguments. See details in the Extra command arguments section. **Authentication** | Click to open the **Authentication** window where you can fill in the Username/Password for override. **Reset to default** | Reset credentials to their default values. **Override host credentials** | Use different host credentials, if necessary. **Local Client** | Specify the path to the Local client. Note The particular set of configuration options depends on the database type. 5. After configuring the settings, click **Start**. 6. Upon successful completion, a notification will appear with information about the process. 7. The backup file can be found in the folder specified during the **Backup settings** step. #### Global PostgreSQL database backup¶ When performing a Global PostgreSQL database Backup, the entire database is dumped, including roles and tablespaces. This differs from standard backup procedures where only specific schemas and their contents can be selected. Additionally, multiple databases can be chosen for backup at once in the global method. To initiate a global backup: 1. Select the desired database. 2. Right-click on the database and choose **Tools** -> **Global Backup**. 3. The **Global Dump** window will appear. Select the necessary objects and click **Next**. 4. The **Backup settings** tab will be displayed. Here you can find the following checkboxes and fields: ![](../images/ug/tools/backup-restore/postgresql-global-dump-window.png) **Setting** | **Description** ---|--- **Encoding** | Set the character encoding for the backup. **Dump only the object definitions, not data** | Includes only the structure of the database objects, excluding the data. **Dump only global objects, no databases** | Includes only global objects and excludes individual databases. **Dump only roles** | Includes only user roles. **Dump only tablespaces** | Captures only tablespaces without the databases. **Do not backup privileges (GRANT/REVOKE)** | Excludes privilege statements like `GRANT` and `REVOKE`. **Discard objects owner** | Excludes the ownership information of the database objects. **Dump passwords for roles** | Includes passwords associated with the user roles. **Output folder** | Specify the directory where the dump file will be saved. For Ultimate Edition, Team Edition, and CloudBeaver versions, users have the option to save to a remote file system using the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png). **File name pattern** | Define the naming pattern for the dump file, with variables like `${database}` and `${timestamp}` to customize the filename. **Extra command args** | Provide additional command-line arguments. See details in the Extra command arguments section. **Authenticate** | Click to open the **Authentication** window where you can fill in the Username/Password for override. **Reset to default** | Reset credentials to their default values. **Override host credentials** | Use different host credentials, if necessary. **Local Client** | Specify the path to the Local client. 5. After configuring the settings, click **Start**. 6. Upon successful completion, a notification will appear with information about the process. 7. The backup file can be found in the folder specified during the **Global backup settings** step. #### Restore PostgreSQL database¶ To initiate a restore: 1. Select the desired database. 2. Right-click on the database and choose **Tools** -> **Restore**. ![](../images/ug/tools/backup-restore/postgresql-restore-window.png) Setting | Description ---|--- **Format** | Choose the format for the restore operation. Options include **Directory** , **Tar** , **Custom** , and **Plain**. **Format** options: | **Directory** : Assumes the input consists of one file per table. Suitable for larger databases as it supports parallel restore. | **Tar** : Assumes the input is an archive in tar format. This is useful when restoring backups made in tar format. | **Custom** : A flexible input format that allows selective restore and other operations. | **Plain** : Assumes the input is a plain-text SQL script file. Suitable for scripts that can be executed with psql. **Clean (drop) database objects before recreating them** | Drop database objects before recreating them from the backup. **Create database** | Create a new database from the backup. **Discard objects owner** | Exclude ownership information during the restore. **Backup file** | Specify the path to the backup file that you wish to restore. For Ultimate Edition, Team Edition, and CloudBeaver versions, use the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png) to select a backup file from a remote file system via [Cloud Storage](../Cloud-Storage/). **Extra command args** | Provide additional command-line arguments. See details in the Extra command arguments section. **Authentication** | Click to open the **Authentication** window where you can fill in the Username/Password for override. **Reset to default** | Reset credentials to their default values. **Local Client** | Specify the path to the Local client. 3. After configuring the settings, click **Start**. 4. Upon successful completion, a notification will appear with information about the process. ## Additional features¶ ### Execute Script Command¶ In DBeaver, besides the standard backup and restore operations, there's an additional capability to run scripts directly through the **Execute script** command. This functionality uses native database clients. ![](../images/ug/tools/backup-restore/postgresql-execute-script-command- window.png) Steps to use the **Execute script** command: 1. Right-click on the desired database in the navigator tree. 2. Navigate to **Tools** -> **Execute script**. 3. A window will appear prompting you to provide the path to your script. Tip In the input field for specifying the path to the SQL file, you can choose a file from a local directory or use the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png) to select a file from a remote file system. The **Execute script** command provides an alternative way to perform database operations that may not be covered by the traditional restore functionality. This includes running complex scripts or batch operations that require direct execution in the database's native environment. ### Extra command arguments¶ The **Extra command args** field allows you to input additional command-line arguments to further customize the dump process. This offers more specific control over the operation. For example, when configuring backup/restore for PostgreSQL, you may want to exclude specific tables. To exclude a table named `employee_data`, use the `--exclude-table` option. Enter `--exclude-table=employee_data` in the **Extra command args** field during the setup process. By doing this, the resulting process won't contain any data or structure from the `employee_data` table. Note Always consult the database's official documentation for a comprehensive list and explanation of available command-line arguments. ### Dump and restore operations as tasks¶ You can set up both restore and dump operations as tasks. To save an operation as a task, click the **Save task** button ![](../images/ug/tools/backup- restore/save-task-button.png) during the dump/restore process. For detailed instructions and features related to task management in DBeaver, refer to [Task management article](../Task-Management/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Basic-operations/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * Basic operations [ Basic operations ](./) Table of contents * First launch * Database navigator * Object editor * Basic operations * Object creation * Working with data in DBeaver UI * Additional Resources * Executing SQL queries * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * First launch * Database navigator * Object editor * Basic operations * Object creation * Working with data in DBeaver UI * Additional Resources * Executing SQL queries 1. [DBeaver](/docs/dbeaver) 2. Getting started # Basic operations This guide outlines the essential steps to quickly get started with DBeaver. Info To begin working with this guide, it is essential that you install the appropriate version of DBeaver for your operating system. Please download it from the official [DBeaver website](https://dbeaver.com/download/). ## First launch¶ When you launch DBeaver for the first time, you will encounter several initial setup windows designed to enhance your experience. This section will guide you through what to expect and how to interact with these prompts. ![](../images/tutorial_images/getting_started/Create-sample-database.png) * **Create Sample Database** : The first window you may see is the **Create Sample Database** prompt. For those new to database management, or if you simply want to explore DBeaver's functionalities without starting from zero, this option is beneficial. It provides a pre-populated database with various data and objects, allowing you to practice and experiment without the need to populate a new database from scratch. For more detailed information, refer to our article on [Sample Database](../Sample-Database/). * **Tip of the Day** : Another feature you will come across is the **Tip of the Day**. This is a helpful tool for learning new tips and tricks about using DBeaver. If you prefer not to see these tips at startup, you can disable this feature by unchecking the **Show tips on startup** checkbox. * **Statistics Collection window** : Lastly, you may see a window related to Statistics Collection. This feature helps you understand how you use DBeaver, which can enhance your user experience. For a more detailed exploration of this feature, please see our article on [Statistics Collection](../Statistics-Collection/). Tip For a detailed understanding of DBeaver interface, refer to the [Application Window Overview](../Application-Window-Overview/) article. ## Database navigator¶ If you opt to create a sample database, you will see it listed in the Database Navigator. The Database Navigator is the central hub for accessing and managing your databases within DBeaver. It allows you to view and interact with the metadata objects of your databases. To explore these objects, click on the arrow located next to the database you have created. This action will expand the list of metadata objects available in your database instance. ![](../images/tutorial_images/getting_started/Database-navigator.png) Tip For an extensive understanding of the Database Navigator's capabilities, refer to the [Database Navigator](../Database-Navigator/) article. ## Object editor¶ From the Database Navigator, you can access the Object Editor, where you have the capability to examine database objects in detail. To view the contents of a table, or to delve into any database object, simply double-click on the desired item. This action will open the Object Editor, providing a comprehensive view and interaction options for the selected object. ![](../images/tutorial_images/getting_started/Object-editor.png) Tip You can also access the Editor using the shortcut (`F4`). For a comprehensive list of shortcuts and their functions, see the article on [Shortcuts](../Shortcuts/). The Object Editor presents a structured environment where you can access different aspects of your database objects through specialized tabs: Tab | Description | Reference Article ---|---|--- **Properties** | Displays the properties of the database object and its sub-entities. | [Properties Editor](../Properties-Editor/) **Data** | Opens the Data Editor for tables and views, facilitating data management. | [Data Editor](../Data-Editor/) **Diagram** | Shows Entity-Relationship Diagrams for tables and schemas, visualizing object relationships. | [Diagrams](../ER-Diagrams/) ## Basic operations¶ Now, let's explore how to work with data. This section will guide you through the essential processes for working with database objects. ### Object creation¶ Creating new objects within your database is a fundamental skill in database management. This process allows you to add structures like tables, views, or schemas, which are essential for storing and organizing your data effectively. 1. In the **Database Navigator** , locate your database. 2. **Create new object** : Depending on the type of object you wish to create, you might need to navigate to different levels within your database connection. ![](../images/tutorial_images/getting_started/Create-new-object.png) 3. First, in the **Database Navigator** , navigate to the level where your new object should be created. This could be at the connection level (for databases and schemas), within a specific database or schema (for tables, views, etc.), or within a table (for columns, foreign keys, indexes, etc.). 4. Right-click on the node (such as a database, schema, table, etc.) where the new object belongs, and select **Create**. A submenu will appear, listing the types of objects you can create at this level. 5. From the submenu, choose the type of object you want to create (e.g., Database, Schema, Table, Column, View, Foreign Key, Index, etc.). If necessary, a dialog will appear, prompting you to enter the details for the new object, such as name, data type, constraints, and other relevant properties. 6. **Fill in the details** : Follow the on-screen instructions to complete the creation of the new object. Some objects may require additional steps or information, such as defining columns for a new table or specifying the reference table and columns for a foreign key. ![](../images/tutorial_images/getting_started/Fill-in-the-details.png) 7. **Save** : To complete the creation of the object, click the **Save** button ![](../images/ug/Save-button-Data-Editor.png). ### Working with data in DBeaver UI¶ 1. **View and Edit Data** : Navigate to your table in the **Database Navigator** , right-click, and select **View Table - > Data** to see the table's contents. Here, you can directly edit the data by typing in new values into the cells, and then save your changes. ![](../images/tutorial_images/getting_started/View-and-edit-data.png) 2. **Inserting new data** : Use the **Add Row** button ![](../images/ug/Add-new-row-button.png) in the table data view to add new records. Fill out the new row with your data and click **Save**. ![](../images/tutorial_images/getting_started/Insert-new-data.png) 3. **Deleting data** : Select the rows you want to remove and click the **Delete current row** button ![](../images/ug/Delete-current-row-button.png). Confirm the deletion and save your changes. ![](../images/tutorial_images/getting_started/Delete-data.png) #### Additional Resources¶ Dive deeper into specific data management topics with these detailed guides: * [New Table Creation](../New-Table-Creation/) * [Creating Columns](../Creating-columns/) * [Implementing Constraints](../Implementing-Constraints/) * [Utilizing Foreign Keys](../Utilizing-Foreign-Keys/) * [Creating Indexes](../Creating-Indexes/) * [Incorporating Triggers](../Incorporating-Triggers/) Info For more on data management, view our tutorials on [YouTube](https://youtube.com/playlist?list=PLkh7-EMxQiV32HDjqUDgk4yH3Idx0dKmi&si=8npeuefyPWaqNX3u). ### Executing SQL queries¶ 1. **Open SQL Editor** : Navigate to the database or schema in the [Database Navigator](../Database-Navigator/), right-click, and select **SQL Editor - > Open SQL Script**. ![](../images/tutorial_images/getting_started/Open-SQL-script.png) 2. **Write your query** : In the [SQL Editor](../SQL-Editor/), write your SQL query. For example, `SELECT * FROM your_table;`. ![](../images/tutorial_images/getting_started/Write-your-query.png) Info Enhance your query writing with these powerful features: \- **[AI SQL Assistance](../AI-Smart-Assistance/)** : Utilize AI to suggest optimizations and best practices for your SQL queries. \- **[SQL Code Editor](../SQL-Code- Editor/)** : Enhance the behavior of the **Script panel** , focusing on features like displaying problem markers, automatic closing of quotes and brackets, semantic analysis, and more. \- **[Spelling](../Spelling/)** : Improve the accuracy of your SQL scripts with integrated spelling correction. 3. **Execute query** : To execute a query, press `Ctrl+Enter` or right-click the query and click **Execute - > Execute SQL Statement** on the context menu. ![](../images/tutorial_images/getting_started/Execute-query.png) Tip You can access various execution option, depending on your requirements. For a comprehensive guide on query execution, refer to [SQL Execution](../SQL- Execution/). 4. **View results** : The results will be displayed in the bottom panel of the **SQL Editor**. ![](../images/tutorial_images/getting_started/View-results.png) Info For those who prefer visual learning or seek further instruction on using SQL with DBeaver, we recommend our [YouTube playlist](https://youtube.com/playlist?list=PLkh7-EMxQiV2DAiruEWgh-i4jreuyX1rP). These video guides complement the written documentation and provide practical examples to enhance your understanding and skills in managing databases with DBeaver. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Bookmarks/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * Bookmarks [ Bookmarks ](./) Table of contents * How to create bookmark * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How to create bookmark 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Database Navigator # Bookmarks Bookmarks are quick access links to objects of a database. They appear in the project tree inside the [Projects](../Projects-View/) or [Project Explorer](../Project-Explorer/) views. ![](../images/ug/Bookmarks.png) ## How to create bookmark¶ To create a bookmark: 1. In the [Database Navigator](../Database-Navigator/) or under **Connections** node of the Projects view, click the database object of interest to focus on it. 2. Press `CTRL+ALT+SHIFT+D`. The **Bookmark Name** dialog box appears. 3. In the **Bookmark Name** field, enter the bookmark name, then in the **Bookmark folder** field, click the folder, and then click **OK** : ![](../images/ug/Bookmark-dialog.png) The bookmark appears in the selected folder of the related project. To open an object using its bookmark, double-click the bookmark or right-click it and click **Open Bookmark** on the context menu. You can rename and delete bookmarks using the context menu as well. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Calc-Panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * Calc Panel [ Calc Panel ](./) Table of contents * Select data * Group data * Use functions * Copy results * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Select data * Group data * Use functions * Copy results 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # Calc Panel The **Calc** panel lets you quickly calculate statistics for selected rows and columns in the [Data editor](../Data-Editor/). Info To open the **Calc** click **Panels - > Calc** on the [Right sidebar](../Data- Editor/#right-sidebar) or use [shortcut](../Shortcuts/#panels). ![](../images/ug/Aggregate-panel.png) ## Select data¶ You can select multiple cells as usual: * Drag with the left mouse button * Hold `Ctrl` or `Shift` while clicking The panel updates automatically to show statistics for the selected data. ## Group data¶ To group data by columns, click **Group by columns** (![](../images/ug/Group- by-columns-button.png)) on the toolbar. Click it again to remove grouping and show summary values for all columns. ## Use functions¶ By default, the panel shows **Count** and **Count distinct**. To add more, click **Add** (![](../images/plus-button.png)) and choose a function: Function | Description ---|--- **Count** | Counts all values, including duplicates and nulls. **Count distinct** | Counts only unique values. **Count nulls** | Counts how many values in the column are `NULL`. **Sum** | Adds up all numeric values. **Average** | Calculates the mean of all numeric values. **Minimum** | Returns the smallest value in the column. **Maximum** | Returns the largest value in the column. **Median** | Returns the middle value when all values are sorted. **Mode** | Returns the most frequent value in the column. Tip Click **Toggle numbers/strings aggregation** (![](../images/ug/Toggle-numbers- strings.png)) to switch between numeric-only and mixed (numeric and string) aggregation. When it’s off, only numeric columns are included in calculations. To remove a function, select it and click **Remove function** (![](../images/tutorial_images/Delete_button.png)) or use the context menu. To clear all, click **Reset** (![](../images/ug/Reset-button.png)). ## Copy results¶ You can copy results in two ways: * **Copy value** \- copies a single function result * **Copy all** \- copies all functions with their values Right-click in the panel to access these options. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Cassandra/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * Cassandra [ Cassandra ](./) Table of contents * Connecting to Cassandra cluster * Browsing Cassandra tables * Executing CQL * ERD * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Connecting to Cassandra cluster * Browsing Cassandra tables * Executing CQL * ERD 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Cassandra Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver supports Cassandra schema browser, data viewer and CQL queries execution. It also supports various administrative tools. ## Connecting to Cassandra cluster¶ You can connect directly to a server or use SSH tunneling or SOCKS proxy. DBeaver uses the DataStax Java driver to operate with a server. It supports Cassandra servers 2.x, 3.x or higher. ![](../images/database/cassandra/cassandra-connection-init.png) ![](../images/database/cassandra/cassandra-connection-ssh.png) ![](../images/database/cassandra/cassandra-connection-ssl.png) ![](../images/database/cassandra/cassandra-connection-tcp.png) ## Browsing Cassandra tables¶ You can browse, view, edit and filter Cassandra tables the same way as with regular (relational) tables. However, being a distributed key-value database, Cassandra does not support any kind of referential integrity. There are no foreign keys, references, etc. You should note that Cassandra has a very advanced (comparing to relational databases) data type system. Each column may be a collection, map, or set of values (with very big number of values). In some cases this makes browsing data in the "Grid" mode inconvenient. ![](../images/database/cassandra/cassandra-schema.png) ![](../images/database/cassandra/cassandra-data-grid.png) ## Executing CQL¶ CQL [Cassandra Query Language](http://cassandra.apache.org/doc/4.0/cql/) is a very simple SQL language dialect. It supports simple SELECT queries, DDL statements (like CREATE TABLE) and some other query types. You can use the standard DBeaver SQL editor to execute CQL queries. DBeaver supports Cassandra query execution, results scrolling, data export/import, mock data generation and other features. Data viewer (of individual tables or custom CQL query results) query tracing is supported. ![](../images/database/cassandra/cassandra-cql-trace.png) ## ERD¶ Physical ERD (Entity Relation Diagram) does not make much sense for Cassandra as there are no foreign keys. However, you can make you own [custom ERD](../Custom-Diagrams/) and connect an actual Cassandra table with each other using logical associations. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Change-current-user-password/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * Change current user password [ Change current user password ](./) Table of contents * Supported databases * How to change the user password * Changing expired user password * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported databases * How to change the user password * Changing expired user password 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Change current user password DBeaver can change credentials for the current database user. ## Supported databases¶ * Cockroach * Exasol * [Greenplum](../Database-driver-Greenplum/) * [MySQL](../Database-driver-MySQL/) * [Netezza](../Database-driver-Netezza/) ![](../images/commercial.png) * [Oracle](../Oracle/) * [PostgreSQL](../Database-driver-PostgreSQL/) * [Redshift](../Database-driver-Amazon-Redshift/) ![](../images/commercial.png) * [Snowflake](../Snowflake/) ![](../images/commercial.png) * [SQL Server](../Database-driver-Microsoft-SQL-Server/) * Vertica ### How to change the user password¶ You can change the current user password in the Navigation Tree according to the instructions below: 1. Connect to the database. 2. Open the context menu by right-clicking on the connection in the Navigation tree. 3. Select a "Security" point and click on a "Change user password" point in a sub-menu. ![](../images/ug/Connection-Security-Change.png) 4. When a new password input dialog opens, enter and confirm the new password. ![](../images/ug/Change-User-Password-Dialog.png) 5. Confirm the password changes. (This dialog will not appear if the entered password is incorrect). ![](../images/ug/Change-User-Password-Save-Settings.png) ## Changing expired user password¶ In DBeaver, you can change an expired password for the following databases: * [DB2](../Database-driver-IBM-Db2/). * [Netezza](../Database-driver-Netezza/) * [Oracle](../Oracle/) * [PostgreSQL](../Database-driver-PostgreSQL/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Clickhouse/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * ClickHouse [ ClickHouse ](./) Table of contents * Setting up * ClickHouse connection settings * Connection details * ClickHouse driver properties * ODBC and JDBC driver configuration * Secure connection configurations * Secure Storage with Secret Providers * Powering ClickHouse with DBeaver * ClickHouse database objects * ClickHouse features in DBeaver * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting up * ClickHouse connection settings * Connection details * ClickHouse driver properties * ODBC and JDBC driver configuration * Secure connection configurations * Secure Storage with Secret Providers * Powering ClickHouse with DBeaver * ClickHouse database objects * ClickHouse features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # ClickHouse This guide provides instructions on how to set up and use ClickHouse with DBeaver. Before you start, you must create a connection in DBeaver and select ClickHouse. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the ClickHouse server using a specific driver. It supports all versions of ClickHouse, but the correct driver must be selected: use `ClickHouse (Legacy)` for driver version 21.3 and earlier, and `ClickHouse` for driver version 21.3 and later. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create- Connection/) article for guidance. ![](../images/database/clickhouse/clickhouse-drivers.png) ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for ClickHouse. ## ClickHouse connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a ClickHouse database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your ClickHouse database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/clickhouse/clickhouse-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your ClickHouse database. **JDBC URL** | If you are connecting via URL, enter the URL of your ClickHouse database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via Host, enter the host address of your ClickHouse database here. **Database/Schema** | Enter the name of the ClickHouse database you want to connect to. **Port** | Enter the port number for your ClickHouse database. The default ClickHouse port is `8123`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with ClickHouse database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### ClickHouse driver properties¶ The settings for ClickHouse **Driver properties** enable you to adjust the performance of ClickHouse ClickHouse JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your ClickHouse database. For a complete walkthrough on setting up ClickHouse JDBC and ODBC drivers properties, you can refer to the official [ClickHouse JDBC documentation](https://clickhouse.com/docs/en/interfaces/jdbc) and [ClickHouse ODBC documentation](https://github.com/ClickHouse/clickhouse- odbc#configuration). These guides detail each driver's properties and how they can be used to optimize ClickHouse database connections. You can customize the ClickHouse driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your ClickHouse database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### ODBC and JDBC driver configuration¶ DBeaver provides extensive capabilities for managing ClickHouse database connections via ODBC/JDBC drivers. This functionality enables you to connect to your ClickHouse database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. This process is similar across most databases that support ODBC/JDBC drivers. For a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver, you can refer to our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ### Secure connection configurations¶ DBeaver supports secure connections to your ClickHouse database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering ClickHouse with DBeaver¶ DBeaver provides a host of features designed for ClickHouse databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### ClickHouse database objects¶ DBeaver lets you view and manipulate a wide range of ClickHouse database objects. DBeaver has extensive support for various ClickHouse metadata types, allowing you to interact with a wide variety of database objects, such as: * Schemas * Tables * Columns * Views * Procedures ### ClickHouse features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for ClickHouse. Beyond regular SQL operations, DBeaver provides a range of ClickHouse-specific capabilities, such as: Category | Feature ---|--- Data Types | ClickHouse data types such as Nested and Array Database Management | ClickHouse Procedures Additional features compatible with ClickHouse, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Schema Management | [Schema Compare ](../Schema-compare/) ![](../images/commercial.png) Mock Data Generation | [Mock data generation guide](../Mock-Data-Generation-in-DBeaver/) ![](../images/commercial.png) Data Visualization | [Query Execution plan](../Query-Execution-Plan/) ![](../images/commercial.png) Note As a column-oriented database management system, ClickHouse does not include support for referential integrity, such as foreign keys. This particular limitation means that Entity-Relationship (ER) diagrams, which are typically valuable in visualizing and enforcing database relationships, become less applicable and effective in the context of ClickHouse databases. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Client-Side-Scripting/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * Client side scripting [ Client side scripting ](./) Table of contents * Supported commands * General commands * Database-specific commands * MySQL * Exasol * Oracle * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported commands * General commands * Database-specific commands * MySQL * Exasol * Oracle 1. [DBeaver](/docs/dbeaver) 2. [SQL Editor](/docs/dbeaver/SQL-Editor) 3. Client side commands # Client side scripting You can use special commands in the [SQL Editor](../SQL-Editor/). Info These commands are executed on DBeaver's side, not on the server-side. ## Supported commands¶ DBeaver supports the following commands: ### General commands¶ Command | Description ---|--- `@ai message` ![](../images/commercial.png) | Sends a natural-language message to the AI Assistant. The AI processes the message and generates an appropriate SQL query or action based on your input. For more details, see [AI command](../AI-command/). `@set var = value` | Sets a script variable. You can use expressions as a value. Variables can be used as SQL queries input parameters. For more information, see [Dynamic parameter bindings](../SQL- Execution/#dynamic-parameters-binding). `@unset var` | Unsets a script variable. `@echo message` | Prints message to output log. You can use a macro in a message (for example `${var}`). `@include fileName` | \- Executes a specified file name, \- Can be used in scripts, \- Opens a new SQL console with the specified file and processes SQL queries as in a regular SQL editor. `@export { ... }` | Opens the data transfer wizard with predefined settings. For more information, see [Export command](../Export-Command/). `@pause message` ![](../images/commercial.png) | Displays a message and waits for the user to press Enter. `@accept var` ![](../images/commercial.png) | Reads user input and saves it into a variable. You can use multiline commands by enclosing them in `@@`. Example `@@set var = 'long multiline value' @@` ### Database-specific commands¶ #### MySQL¶ Command | Description ---|--- `source fileName` | Executes a SQL script from a file in MySQL CLI syntax. For details, see [MySQL documentation for `source` command](https://dev.mysql.com/doc/refman/8.4/en/mysql-batch-commands.html). #### Exasol¶ Command | Description ---|--- `define var = value` | Declares and assigns a variable in Exasol EXAPlus syntax. For details, see [Exasol documentation for `DEFINE`](https://docs.exasol.com/db/latest/connect_exasol/sql_clients/exaplus_cli/alphabeticallistofexapluscommands/define.htm). #### Oracle¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Command | Description ---|--- `Pause`/`Pau` | Displays a message and waits for the user to press Enter. Skips prompt if no text is provided. For details, see [Oracle documentation for `PAUSE` command](https://docs.oracle.com/en/database/oracle/oracle-database/19/sqpug/PAUSE.html). `Accept` | Reads user input and saves it into a variable. Supports datatypes, formats, defaults, prompts, and hidden input. For details, see [Oracle documentation for `ACCEPT` command](https://docs.oracle.com/en/database/oracle/oracle-database/19/sqpug/ACCEPT.html). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Cloud-Explorer/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * Cloud explorer [ Cloud explorer ](./) Table of contents * Supported Databases * Cloud configuration * First-time setup * Add a new configuration * Amazon Web Services * Google Cloud Platform * Microsoft Azure * Configuring SSH Tunnels * Explorer * Database cloud information * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported Databases * Cloud configuration * First-time setup * Add a new configuration * Amazon Web Services * Google Cloud Platform * Microsoft Azure * Configuring SSH Tunnels * Explorer * Database cloud information 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. Cloud explorer # Cloud explorer Note This feature is available in [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions, as well as in [CloudBeaver Enterprise](/docs/cloudbeaver). **Cloud Explorer** offers deep integration with popular cloud service providers. As of the latest version, it supports Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. With **Cloud Explorer** , you can set up your cloud access once and then easily browse, connect, and manage your cloud databases. It saves you from manually configuring each database connection, as it reads all database endpoint information directly from the cloud provider. Authentication is centralized. You use your cloud account to access your cloud databases. Before you start using **Cloud Explorer** , you need to set up your cloud provider access. This setup includes access credentials, availability zones for database search, and other cloud-specific settings. ## Supported Databases¶ The **Cloud Explorer** allows you to easily connect with and manage various databases. Here is the list of databases it supports: Providers | Databases ---|--- **Amazon Web Services** | PostgreSQL | MySQL | Oracle | Amazon Redshift | Amazon Athena | Amazon DocumentDB | Amazon DynamoDB | Amazon Keyspaces | Amazon ElastiCache (Redis) | Amazon Timestream | Amazon Neptune **Google Cloud Platform** | AlloyDB for PostgreSQL | Microsoft SQL Server | PostgreSQL | MySQL | Spanner | Firestore | BigQuery | Bigtable **Microsoft Azure** | Microsoft SQL Server | PostgreSQL | MySQL | Azure Cosmos DB for MongoDB | Azure Cosmos DB for Cassandra | Azure Cosmos DB for NoSQL ## Cloud configuration¶ To start configuring, click the **Cloud Explorer** button ![](../images/ug/cloud-explorer/cloud-explorer-button.png) in the [Toolbar](../Application-Window-Overview/#toolbar). ### First-time setup¶ If this is your first time, the **Create Cloud Configuration** dialog opens automatically. Use it to: * Enter your access credentials. * Specify availability zones for database search. * Adjust cloud-specific settings. Once completed, **Cloud Explorer** will display your cloud databases. Note Cloud configuration steps differ for each cloud provider. ### Add a new configuration¶ To create an additional setup, click the **New** button ![](../images/plus- button.png) in the **Cloud Explorer** dialog. ### Amazon Web Services¶ Name | Description | Additional article ---|---|--- **Default Credentials** | Allows AWS to determine credentials using the standard credential providers. | [AWS Default credentials](../AWS-Credentials/#default-credentials) **AWS Profile** | Allows you to choose which credentials profile you want to use. | [AWS Profile](../AWS-Credentials/#aws-profiles) **Access/Secret Key** | Allows you to choose which credentials profile you want to use. If you have an [AWS Secret](../AWS-Credentials/#aws-secrets-manager) set up, enter it in the [Connection settings](../Edit-Connection/). | [AWS Access/Secret Key](../AWS-Credentials/#access-keys) **Single Sign-On (SSO)** | Allows access to AWS resources without explicitly specifying user credentials in DBeaver connections configuration. | [AWS SSO guide](../AWS-SSO/) Tip For more details, see [how to connect an AWS database using Cloud Explorer](../AWS-Cloud-Explorer/). About permissions, read [AWS managed policies](../AWS-Permissions/) article. ### Google Cloud Platform¶ Name | Description | Additional article ---|---|--- **Default Credentials** | Allows GCP to determine credentials using the standard credential providers. | [GCP Default credentials](../GCP-Credentials/#default-credentials) **Web browser** or **SSO** | Allows you to authorize your connection through your Google account without needing a service or user-based key file. | [GCP SSO](../GCP-SSO/) **Access key file** | Allows you to provide the path to your service or user credentials files. | [GCP Access key](../GCP-Credentials/#key-file) Tip For more details, see [how to connect Google database using Cloud Explorer](../Google-Cloud-Explorer/). ### Microsoft Azure¶ There are several environment variables available for Microsoft Entra ID. For detailed information on Entra ID authentication, see [Authentication Microsoft Entra ID](../Authentication-Microsoft-Entra-ID/). Tip For more details, see [how to connect Azure database using Cloud Explorer](../Azure-Cloud-Explorer/). ### Configuring SSH Tunnels¶ DBeaver supports SSH tunnel connections for enhanced security when accessing cloud databases. Detailed instructions for setting up SSH tunnels in DBeaver are available in the [SSH Tunnel Configuration](../SSH- Configuration/#configuring-cloud-ssh-tunnels) article. ## Explorer¶ Once you've configured your cloud provider access, open the **Cloud Explorer** dialog and add database connections. In the top drop-down of the explorer dialog, you can select the active cloud configuration or click **Edit** button ![](../images/ug/cloud-explorer/edit-configuration-button.png) to change the cloud configuration. You can see cloud databases in the center of the dialog in a hierarchical view. All databases are grouped by database/service type. When you expand one of the top elements, DBeaver will search cloud databases in configured availability zones/regions. ![](../images/ug/cloud-explorer/aws-cloud-databases.png) If you have a large number of databases in your cloud, you can search or filter them using filter text above the cloud navigator. You can drag-and-drop cloud databases directly to [database navigator view](../Database-Navigator/) or [projects view](../Projects-View/). You can also add any number of databases to your project directly from the **Cloud Explorer**. To do this, click on the database you want to add. Once selected, click on the **Add to Project** button ![](../images/ug/cloud-explorer/add-to- project-configuration-button.png) located in the bottom right corner of the **Cloud Explorer** dialog, or right-click on the database and select **Add to Project** from the context menu. This will add the selected database to your project, making it easier to manage and navigate your databases within specific projects. ## Database cloud information¶ You can access your cloud database configuration directly from the **Database Navigator**. To do this, right-click on the database you are interested in and select **Edit Connection**. This action opens a special tab in the connection settings dialog. The information displayed in this tab is specific to the cloud and database type of the selected database. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Cloud-Storage/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * Cloud storage [ Cloud storage ](./) Table of contents * Cloud Storage * Capabilities in Cloud Storage * Direct capabilities in Cloud Storage * Additional interactions via other features * Trust cloud provider certificates * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Cloud Storage * Capabilities in Cloud Storage * Direct capabilities in Cloud Storage * Additional interactions via other features * Trust cloud provider certificates 1. [DBeaver](/docs/dbeaver) 2. Cloud services # Cloud storage Note This feature is available in [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions, as well as in [CloudBeaver Enterprise](/docs/cloudbeaver). **Cloud Storage** lets you manage files in your cloud environment. This feature simplifies working with cloud-stored files - upload, download, and organize files just like in a local file system. It supports: * [Amazon S3](https://aws.amazon.com/s3/) * [Google Cloud Storage](https://cloud.google.com/storage/) * [Azure Blob Storage](https://azure.microsoft.com/products/storage/blobs/) To use **Cloud Storage** , set up a cloud access [configuration](../Cloud- Explorer/#cloud-configuration) in the Cloud Explorer. ## Cloud Storage¶ After configuring your cloud provider access, you can start using **Cloud Storage**. To access it: * Click the **Cloud Storage** button ![](../images/ug/cloud-storage/Cloud-storage-button.png) on the toolbar. * Alternatively, go to the menu and select **Window - > Cloud Storage**. This action will launch a window displaying the cloud services for which credentials were provided during setup. In this window, use the dropdown menu to navigate through folders and view files stored in the cloud. ![](../images/ug/cloud-storage/Cloud-Storage.png) You can filter and sort your folders and files by their name or region using the interface's `Name` and `Region` columns. Click on the respective column header to organize the displayed folders, according to these criteria, especially useful when managing a large number of folders. ## Capabilities in Cloud Storage¶ The **Cloud Storage** offers a range of functionalities for managing files within the cloud. Here are the actions you can perform: ### Direct capabilities in Cloud Storage¶ Some functionalities are directly accessible within the **Cloud Storage** interface: Capability | Description ---|--- **Open Resource** | Open a folder in a new window to view details like `Name`, `Path`, `Size`, `Location`, and `Last Modified`. Double-click on the folder, or right-click on the folder and select **Open resource`folder name`** from the context menu. Use the **Configure columns** button ![](../images/ug/Configure-button.png) to customize which columns are displayed in the window, tailoring the view to your specific needs. In the opened window, use the **Search item** button ![](../images/ug/Search- icon.png) to conduct searches within the folder. **Create new folder** | Create new folders within the cloud environment. To do this, right-click where you want the new folder and select **Create New Folder** button ![](../images/ug/Create-new-folder-button.png). **Save resource(s) to local disk** | Save selected resource(s) from the cloud to the local disk. Select the file(s) or folder(s) in **Cloud Storage** you wish to download, then choose the **Save resource(s) to local disk** option ![](../images/ug/Save-to-local-disk-button.png) available both in the top toolbar of **Cloud Storage** and the context menu. **Load resource(s) from local disk** | Upload resource(s) from the local disk to the cloud. Select the target folder in **Cloud Storage** where you want to upload files, then choose the **Load resource(s) from local disk** option ![](../images/ug/Load-from-file-button.png) which can be found in the top toolbar of **Cloud Storage** as well as the context menu. Tip In addition to the **Save to local disk** and **Load from local disk** features, you can also copy files using the drag-and-drop mechanism. You can drag files between **Cloud Storage** and your **local disk** , or between **Cloud Storage** and [Project Explorer](../Project-Explorer/). ### Additional interactions via other features¶ Some functionalities of **Cloud Storage** are accessible through the integration with other features of DBeaver: Capability | Description ---|--- **Export/Import files** | Export to or import files from folders within the **Cloud Storage**. Details are available in [Data transfer](../Data-transfer/) article. **Backup/Restore** | Perform backup and restore operations using files from or saving outputs to the **Cloud Storage** , as detailed in [Backup and Restore](../Backup-Restore/). **Data compare** | After comparing files or folders, save the results directly to **Cloud Storage**. Details are available in [Data Comparison](../Data-compare/). **Schema Compare** | Compare database schemas and optionally save comparison results to **Cloud Storage**. Further information is found in [Schema Comparison](../Schema-compare/). Tip To ensure you see the most updated information after performing file-related actions in **Cloud Storage** , it's important to refresh the folder manually. Right-click on the folder and select the refresh option ![](../images/ug/Refresh-projects-icon.png) from the context menu. ### Trust cloud provider certificates¶ If you run into connection errors or SSL trust issues when connecting to cloud databases or services, the problem may be caused by missing certificate authorities (CAs). For details, see [Managing truststore settings](../Managing-Truststore-Settings/#extended-cloud-certificates). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Command-Line/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * Command line [ Command line ](./) Table of contents * Windows * MacOS * Linux * Using dbeaver.ini * Command line parameters * DBeaver control * System parameters * VM parameters * Connection parameters * Install Eclipse extensions * Exit codes * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Windows * MacOS * Linux * Using dbeaver.ini * Command line parameters * DBeaver control * System parameters * VM parameters * Connection parameters * Install Eclipse extensions * Exit codes 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Command line Command line parameters can be passed directly to the DBeaver executable. The way to do this depends on your operating system. ## Windows¶ You can use the `dbeaverc.exe [parameters]` executable. This version doesn’t spawn a new window, so you can see output messages in the same terminal. ## MacOS¶ Parameters can be passed in two ways: * Use the `open` command with the `-a` flag and the app name, followed by `--args` and your parameters. Depending on the edition, use `DBeaver.app`, `DBeaverLite.app`, `DBeaverEE.app`, or `DBeaverUltimate.app`. Example `open -a "DBeaver.app" --args [parameters]` This method does **not** redirect logs, `stdout`, or `stderr` to the terminal. * Run the actual executable directly from inside the `.app` package. Example `/Applications/DBeaver.app/Contents/MacOS/dbeaver [parameters]` This method **does** redirect logs, `stdout`, and `stderr` to the terminal. ## Linux¶ Pass parameters directly to the DBeaver executable in the terminal. Example `/usr/bin/dbeaver-ce [parameters]`. This method redirects logging messages, `stdout`, and `stderr` to the terminal. ## Using dbeaver.ini¶ Parameters can also be added in the `dbeaver.ini` configuration file. These should be written at the beginning of the file, with each parameter on its own line. Tip Detailed instructions on finding `dbeaver.ini` are available in [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). ## Command line parameters¶ ### DBeaver control¶ Name | Value | Example ---|---|--- `-help` | Prints help message. | `-stop` | Quits DBeaver. | `-dump` | Prints DBeaver thread dump. [Learn more about Thread Dump](../Making-a-thread-dump/) | `-f` | Opens the file in DBeaver UI, if the command has `-con` argument, connects it to datasource. | `-f c:\some-path\some-file.sql` `-connect` | Opens database connection in DBeaver UI. Learn more | See connection parameters table `-closeTabs` | Closes all open editor tabs. | `-disconnectAll` | Closes all open connections. | `-reuseWorkspace` | Forces reuse of single workspace by multiple DBeaver instances. | `-newInstance` | Forces new DBeaver instance creation (do not try to reuse already running one). | `-bringToFront` | Brings the DBeaver window on top of other applications. | `-runTask` ![](../images/commercial.png) | Executes specified [task](../Task-Management/#run-tasks-from-the-command-line). The command returns an exit code that indicates success or failure. | `-runTask @projectName:taskName`. `-var` ![](../images/commercial.png) | Customs variables for runTask. You can add several parameters at once to the command line, each starting with `-var`. Used right after `-runTask`. Example: `-var variableName=variableValue`. | `-runTask exportFromSakila` `-var film=sakila.film` `-var actor=sakila.actor` `-vars` | Path to a property file with variables. | `-vars c:\path\to\file.properties` For more information, see [Declare external variables in a file](../Admin- Variables/#declare-external-variables-in-a-file) `-license` | Path to the license file. | `-license "/etc/licenses/dbeaver.txt"`. Important Place task variables (`-var`) after the `-runTask` command. Example: -runTask @General:export -var test=123 ### System parameters¶ Name | Value | Example ---|---|--- `-nl` | UI language and locale (affects UI translation, number/date formats). For supported values, see [Supported languages](../UI-Language/#supported-languages). | `-nl "en_US"` `-data` | Workspace path. | `-data "c:\ProgramData\MyWorkspace"` `-nosplash` | Omits splash screen. | `-clean` | Clears all Eclipse caches. Use it if DBeaver fails to start after it upgrades. | `-vmargs` | Passes VM parameters. | See VM arguments table Important The `-data` parameter only affects the **workspace** location. Other folders are created in the [default location](../Workspace-Location/#default-location- of-the-workspace). #### VM parameters¶ You can pass any advanced Java parameters supported by your local JVM. Parameters supported by HotSpot JVM (21): `https://docs.oracle.com/en/java/javase/21/docs/specs/man/java.html` Parameters supported by all JVMs: Name | Value | Example ---|---|--- `-Xms` | Sets initial memory available for DBeaver. | `-Xmx1000m` `-Xmx` | Sets maximum memory available for DBeaver. | `-Xmx4000m` #### Connection parameters¶ Use the `-con` argument to open a database connection in the DBeaver UI. Pass all parameters as a **single string** , using: * `|` to separate parameters * `=` to separate names and values Example `-con "driver=sqlite|database=C:\db\SQLite\Chinook.db|name=SQLite"` See the table below for supported arguments. Name | Description | Example ---|---|--- `name` | Connection name. | `Test connection` `driver` | Driver name or ID. | `driver=sqlite`, `driver=mysql`, etc `url` | Connection URL. Optional (JDBC URL may be constructed by a driver from other parameters). | `url=jdbc:sqlite:C:\db\SQLite\Chinook.db` `host` | Database host name (optional). | `host=localhost` `port` | Database port number (optional). | `port=1534` `server` | Database server name (optional). | `server=myserver` `database` | Database name or path (optional). | `database=db-name` `user` | User name (optional). | `user=root` `password` | User password (optional). | `password=mysecret` `auth` | Authentication model ID. See [Auth models](../Database-authentication-models/). | `auth=postgres_pgpass` `authProp.propName` | Custom authentication parameters (depends on the driver and [auth model](../Database-authentication-models/)). | `authProp.oracle.net.wallet_location=C:/temp/ora-wallet` `savePassword` | Does not ask user for a password on connection. | `savePassword=true` `showSystemObjects` | Shows/Hides system schemas, tables, etc. | `showSystemObjects=true` `showUtilityObjects` | Shows/Hides utility schemas, tables, etc. | `showUtilityObjects=true` `folder` | Puts a new connection in a folder. | `folder=FolderName` `autoCommit` | Sets connection auto commit flag (default value depends on driver). | `autoCommit=true` `prop.propName` | Advanced connection parameters (depend on driver). | `prop.connectTimeout=30` `id` | Connection id. | `oracle_thin-16a88e815bd-70598e648cedd28c` (useful in conjunction with `create=false`) `connect` | Connects to this database. | `connect=false` `openConsole` | Opens the SQL console for this database (sets `connect` to true). | `openConsole=true` `create` | Creates new connection. | `create=false` (true by default). If it is set as false, then an existing connection configuration will be used. The name or id parameter must be specified. `save` | Saves new connection. | When `create=true`, then `save=false` (default) makes new connection temporary, `save=true` means that new connection will be saved and accessible between DBeaver launches. Tip See how to [declare external variables in a file](../Admin-Variables/#declare- external-variables-in-a-file) ### Install Eclipse extensions¶ You can install additional Eclipse-compatible extensions directly from the command line using the built-in P2 Director. This method doesn’t require the graphical interface. Name | Value | Example ---|---|--- `-application` | Defines which Eclipse application to run. Use `org.eclipse.equinox.p2.director` to install extensions via the built-in Eclipse P2 Director. | `-application org.eclipse.equinox.p2.director -repository https://wakatime.com/eclipse/update-site/ -repository https://download.eclipse.org/releases/2025-06/ -installIU com.wakatime.eclipse.feature.feature.group -followReferences` Info For details on Eclipse P2 Director syntax and available arguments, see the [official Eclipse documentation](https://help.eclipse.org/latest/topic/org.eclipse.platform.doc.isv/guide/p2_director.html?cp=2_0_20_2) ## Exit codes¶ When DBeaver finishes executing a command, it returns an **exit code** to indicate the result. Code | Name | Description ---|---|--- `-1` | `EXIT_CODE_CONTINUE` | Indicates that the process continues running. You won’t normally see this code when running commands. `0` | `EXIT_CODE_OK` | Command executed successfully. `1` | `EXIT_CODE_ERROR` | A general error occurred during execution. `2` | `EXIT_CODE_ILLEGAL_ARGUMENTS` | Invalid command line arguments were provided. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Composite-Tasks/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * Composite tasks [ Composite tasks ](./) Table of contents * Creating a Composite task * Editing a Composite task * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Creating a Composite task * Editing a Composite task 1. [DBeaver](/docs/dbeaver) 2. Tasks # Composite tasks Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. DBeaver allows you to create composite tasks that incorporate multiple other tasks. For example, you can group various data export tasks into a composite task, making managing and running them together at a set time simpler. ## Creating a Composite task¶ 1. To start creating a composite task, open the **Create a task** dialog. You can do this by: * Right-clicking in the database navigator and selecting **Tools - > Create new task...** * Clicking on **Database - > Tasks -> Create new task...** * Navigating to **Database - > Tasks -> Database tasks**, right-clicking, and choosing **Create new task...** ![](../images/ug/tasks/creating-a-composite-task.png) In the **Create a task** wizard, select **Composite task**. Enter a name, and optionally add a description and a task folder. Click **Next** to continue. 2. In the task configuration dialog, you can add tasks to your composite task using these controls: ![](../images/ug/tasks/specify-tasks.png) Button/Checkbox Name | Button Image | Description ---|---|--- **\+ (Add)** | ![](../images/ug/tasks/add-task-button.png) | Click to add existing tasks. **Create and add new task** | ![](../images/ug/tasks/create-and-add-new-task-button.png) | Directly creates a new task and adds it to the composite task. **Edit task** | ![](../images/ug/tasks/edit-task-button.png) | Change the settings of a selected task. **Delete task** | ![](../images/ug/tasks/delete-task-button.png) | Removes the selected task from the composite task. **Drag-and-drop area** | | Drag tasks from **Database tasks** and drop them here to add them to the composite task. **Ignore task error** | | Allows the composite task to continue even if one task fails. **Show all notifications** | | Shows all notifications for the tasks within the composite task. Note A composite task can also include other composite tasks. 3. After setting up the tasks, click **Proceed** to save and start the composite task. Tip You can set a [timeout](../Task-Management/#set-task-timeout) for each task to avoid blocking others. ## Editing a Composite task¶ To edit a composite task, go to **Database - > Tasks -> Database Tasks**. Here, you can edit, delete, or rearrange tasks in your composite task. ![](../images/ug/tasks/database-tasks.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Configuration-files-in-DBeaver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * Configuration files [ Configuration files ](./) Table of contents * Configuration files * dbeaver.ini * How to Locate the dbeaver ini * Other configuration files * Location of the other configuration files * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configuration files * dbeaver.ini * How to Locate the dbeaver ini * Other configuration files * Location of the other configuration files 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Configuration files DBeaver utilizes several configuration files to tailor the application to user needs. These files include: * `dbeaver.ini` * `data-sources.json` * `tasks.json` ## Configuration files¶ Each of the listed files serves a specific purpose, from storing data sources and tasks to overall application settings. ## dbeaver.ini¶ Through modifications to `dbeaver.ini`, you can apply licenses, manage drivers, enhance security, adjust user interface settings, and more. Configuration | Description ---|--- [License Management](../License-Administration/) | Configure Enterprise Edition with a specific license. [Driver Management](../Admin-Manage-Drivers/) | Manage and automate the provisioning of database drivers. [Administrative Preference Restrictions](../Admin-Preference-Restrictions/) | Implement restrictions to enhance application security and control over available functionalities. [AI-Smart Assistance](../AI-Smart-Assistance/) | Control the AI-Smart Assistance feature, including the option to disable it. [Command-Line Parameters](../Command-Line/) | Customize DBeaver startup and operational parameters through the command line. [JDBC Tracing](../JDBC-Tracing/) | Enable tracing for JDBC operations to diagnose and troubleshoot issues. Tip DBeaver also utilizes preference files to further customize and optimize the user experience. These preference files allow users to fine-tune the application settings and behaviors according to their specific needs. For detailed information, refer to the [Admin manage preferences](../Admin- Manage-Preferences/) article. ### How to Locate the dbeaver ini¶ The `dbeaver.ini` file's location varies depending on the operating system and the method of installation. As a general rule, you can find `dbeaver.ini` in the directory where DBeaver is installed. For macOS, specifically, it is located in the `Contents/Eclipse` subfolder of the application. Here are the common locations based on the operating system and installation method: Operating System | Location of `dbeaver.ini` ---|--- **macOS** | `./Applications/[DBeaver Edition].app/Contents/Eclipse/dbeaver.ini` **Linux** | `/usr/share/dbeaver-[edition]/dbeaver.ini` for installations via `.deb`, `.rpm`, or PPA packages. **Windows** | `C:\Program Files\[DBeaver Edition]\dbeaver.ini` for a default installation. Info Replace `[DBeaver Edition]` with your specific installation, such as `Dbeaver` for Community Edition, `DBeaverLite` for Lite Edition, `DBeaverEE` for Enterprise Edition, and `DBeaverUltimate` for Ultimate Edition. ## Other configuration files¶ The `data-sources.json` and `tasks.json` configuration files in DBeaver serve crucial roles, particularly when it comes to the portability of database connections and tasks configurations across different DBeaver installations. Configuration file | Capabilities ---|--- `data-sources.json` | The value of `data-sources.json` lies in its ability to facilitate the migration of database connections from one DBeaver installation to another. This is particularly useful when moving to a new workstation, setting up a team member with the same database connections, or ensuring consistency across different environments for testing or development purposes. `tasks.json` | This file stores the configuration for various tasks, such as SQL scripts execution, data transfer operations, and other automated tasks. Similar to `data-sources.json`, `tasks.json` allows for the easy migration of configured tasks from one DBeaver instance to another. ### Location of the other configuration files¶ The location of `data-sources.json` and `tasks.json` files is consistent across all operating systems, relative to the DBeaver workspace: * **data-sources.json** : `./workspace6/General/.dbeaver/data-sources.json` * **tasks.json** : `./workspace6/General/.dbeaver/tasks.json` Tip Detailed instructions on finding your workspace are available in [Workspace Location](../Workspace-Location/) article. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Configure-Connection-Initialization-Settings/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * Initialization settings [ Initialization settings ](./) Table of contents * Accessing Connection Initialization Settings * Settings * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Accessing Connection Initialization Settings * Settings 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Initialization settings During the initialization of a new database session, the Connection Initialization Settings provide a customizable set of parameters. These settings ensure that every time you connect to the database, certain predefined behaviors are automatically initialized. This feature allows you to set the: * Transaction management options such as auto-commit status and transaction isolation levels. * Defaults for the initial database and schema selection upon connection establishment. * Network handling features like keep-alive settings and idle connection timeout. * Bootstrap queries to execute predetermined SQL commands at the start of every session. ![](../images/ug/Connection-initialization-settings-page.png) ## Accessing Connection Initialization Settings¶ To configure the Initialization Settings for your database connections, follow these steps: **For a new connection** : 1. [Create a new connection](../Create-Connection/). 2. In the connection creation wizard, navigate to **Connection details - > Connection Initialization Settings** to specify your preferences. **For an existing connection** : 1. Go to the [**Database Navigator**](../Database-Navigator/), find the connection you want to configure. 2. Right-click on it and select **Edit Connection**. 3. In the edit menu, navigate to the **Initialization** tab where you can adjust the settings. ## Settings¶ Setting | Description ---|--- **Auto-commit** | Determines if each SQL statement is committed automatically upon execution. **Isolation level** | Sets the transaction isolation level which defines the degree of visibility of transactions to each other. | **Read uncommitted** : Allows a transaction to read data that has not yet been committed by other transactions. | **Read committed** : Ensures a transaction only reads data that has been committed at the time the transaction began. | **Repeatable read** : Guarantees if a row is read twice in the same transaction, the result will be the same. | **Serializable** : Ensures transactions occur in a completely isolated fashion, equivalent to serial transaction execution. **Default database** | Specifies the default database to be selected once the connection is established. **Default schema** | Indicates the default schema to be used within the selected database. **Keep-Alive** | Interval (seconds) for sending a signal to maintain the connection open during user inactivity. **Close idle connections after** | The duration in seconds after which idle connection (with no activity) will be closed. Unchecking this option allows the connection to remain active indefinitely. If the field is set to zero, the system will apply the values configured in the [Connection Types](../Connection-Types/#create-connection-type) settings. If a value other than zero is specified, that value will override the default settings from the Connection Types. **Bootstrap queries** | Allows configuration of specific SQL queries to run at the start of the session. Note The transaction isolation levels and available schemas can only be viewed by clicking on **Test Connection** after the connection has been established. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Connecting-to-Oracle-Database-using-JDBC-OCI-driver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * JDBC OCI driver [ JDBC OCI driver ](./) Table of contents * Prerequisites * Configuration * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Prerequisites * Configuration 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. Oracle # JDBC OCI driver This article discusses how to establish connections to an Oracle database using JDBC OCI (Type II). Please take into consideration that the proposed way uses DBeaver's Generic driver. It means that you cannot get Oracle-specific functionality this way. ## Prerequisites¶ JDBC OCI connections require [Oracle Instant Client](https://www.oracle.com/database/technologies/instant- client/downloads.html) on the local machine. Please pay attention to the Instant Client and the JDBC driver versions, as they must be identical. DBeaver uses the 12.2.0.1 version by default at the moment, so we recommend using the 12.2.0.1 version of the Instant Client. Extract or mount the Instant Client package as per your operating system and place the files in a selected folder. We will refer to this folder as ORA_HOME for the rest of the article. Append `ORA_HOME` to the PATH variable and restart DBeaver before proceeding. ## Configuration¶ 1. **Creating`tnsnames.ora` file** 2. If you do not have a `tnsnames.ora` file, create one by following these steps: * Open a text editor. * Add your Oracle database connection details, which typically include the network alias, a description of the connection, and address parameters such as hostname and port number. For example: MYDB = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = myhost.example.com)(PORT = 1521)) (CONNECT_DATA = (SERVER = DEDICATED) (SERVICE_NAME = mydbservice.example.com) ) ) * Save the file as `tnsnames.ora`. 3. Place the newly created or existing `tnsnames.ora` file in the `ORA_HOME/network/admin` directory. 4. **Configuring driver in DBeaver** 5. In DBeaver, go to **Window - > Driver Manager -> New** to open the **Create new driver** dialog. 6. In the Settings tab: * Assign a **Driver name** as preferred. * Set **Class Name** to `oracle.jdbc.OracleDriver`. * Use `jdbc:oracle:oci:@tnsAlias` as the URL Template, where **tnsAlias** is an alias from your `tnsnames.ora` file. * Ensure the Driver Type is Generic. Tip While selecting the Generic driver type is recommended for broader compatibility, it's not mandatory. You can choose the Oracle driver type to access Oracle-specific features. However, be aware that using a non-generic driver might lead to unexpected errors with some JDBC functionalities. 1. **Adding maven artifacts in DBeaver** 2. Under the Libraries tab, click **Add Artifact**. 3. Insert the below XML in the text field. com.oracle.database.jdbc ojdbc8 12.2.0.1 com.oracle.database.nls orai18n 12.2.0.1 com.oracle.database.xml xdb6 12.2.0.1 com.oracle.database.xml xmlparserv2 12.2.0.1 Note Replace the versions of the artifacts if you use a different version of the Instant Client. 4. **Configuring driver properties** 5. Go to the Driver properties tab. 6. Right-click and choose **Add new property**. 7. Set the property name to `protocol` (without quotes). 8. Set the Value to `oci` (without quotes). 9. Once you have configured the properties, close the Driver Manager. 10. Create a new connection in DBeaver using the driver you have just configured. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Connecting-to-Oracle-databases/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * Oracle authentication [ Oracle authentication ](./) Table of contents * Configuration types * Basic connections * TNS * Custom URL * Authentication * Database * OS authentication * Oracle Wallet * Kerberos * Oracle Cloud connections * Plain URL connection * Oracle Wallet connection * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configuration types * Basic connections * TNS * Custom URL * Authentication * Database * OS authentication * Oracle Wallet * Kerberos * Oracle Cloud connections * Plain URL connection * Oracle Wallet connection 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. Oracle # Oracle authentication There are several ways to configure a database connection and several ways to perform an authentication. ![](../images/database/oracle/oracle-connection-main.png) ## Configuration types¶ ### Basic connections¶ Host/port based configuration Parameter | Description | Example ---|---|--- Host | Server host name | 192.168.1.25 Post number | Server listener port | 1521 (default) Database | Service or SID name | ORCL Service/SID | It depends on the server configuration. SID must be selected for some servers and the Service Name for others | SID ### TNS¶ TNS configuration is the simplest, but it requires you to have the `tnsnames.ora` file somewhere on your disk. tnsnames.ora contains information about all accessible Oracle server connections. DBeaver can determine the default location of this file, but sometimes you will need to manually specify it. Parameter | Description | Example ---|---|--- Network Alias | Name of configuration from tnsnames.ora | ORCL1 TNS names path | Path to `tnsnames.ora` file. By default, it is got from the TNS_ADMIN environment variable or from Windows' registry | c:\oracle\network\admin ### Custom URL¶ For a more sophisticated configuration, you can specify the full JDBC URL manually ( see [Data Sources and URLs](https://docs.oracle.com/database/121/JJDBC/urls.htm#JJDBC28270)). Sample URL (Oracle Cloud): `jdbc:oracle:thin:@(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.us- ashburn-1.oraclecloud.com))(connect_data=(service_name=xxxxxxxxxxxxxxxxx_high.adb.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom- east-1.oraclecloud.com, OU=Oracle BMCS US, O=Oracle Corporation, L=Redwood City, ST=California, C=US")))` ## Authentication¶ ### Database¶ Parameter | Description | Example ---|---|--- User name | Database user name | SYS Password | Database user password | Role | Role for connection. Roles SYSDBA and SYSOPER are needed for some administrative operations | Normal Save password | Saves the user/password information in the local DBeaver configuration | SID ### OS authentication¶ The Oracle driver gets user information from the current OS user. You do not need to explicitly specify any credentials. ### Oracle Wallet¶ A more secure way to connect is to use the Oracle Wallet. Wallet is a directory with security keys and some other optional connection information. Wallets are usually distributed as ZIP archives. You need to extract the ZIP archive to a folder on a disk and specify this folder in the `Wallet location` field. Wallet may contain information about a database user. This, however, is optional. You will sometimes need to specify the user too. Wallet may also contain a TNS configuration. If it does, you can use the TNS connection configuration easily by setting the `TNS path` to the same value as the `Wallet location`. Parameter | Description | Example ---|---|--- User name, Password, Role | See Database authentication | Wallet location | Oracle wallet directory | C:\oracle\network\wallet\example Wallet password | Optional. Some wallets are password-protected | ### Kerberos¶ Kerberos is the most complicated authentication in Oracle. Parameter | Description | Example ---|---|--- Username | Database user name | c##testuser Kerberos user | Kerberos / Active directory user name | testuser@THE-REALM Realm | Kerberos realm | THE-REALM KDC server | KDC server address | krb5.your-domain.com Password | Kerberos user password | ## Oracle Cloud connections¶ DBeaver supports Oracle Cloud Autonomous databases connectivity. There are two ways to authenticate: ### Plain URL connection¶ * To use a plain URL connection you must enable the `Access control list` for the Oracle autonomous database. * Then add your IP address to the IP list. * Use the Custom connection configuration (URL). You can copy the URL from the Oracle Cloud database page (link "DB Connection"). ### Oracle Wallet connection¶ It is the default authentication type for the Oracle Cloud. * Download Wallet from the Oracle Cloud website * Expand the wallet archive to a folder * Set TNS configuration type * Set the `TNS path` to the wallet location directory * Choose the proper `Network Alias` from the drop-down menu * Set `Authentication` to the Oracle Wallet * Set the database username and password (you can get them from the Oracle Cloud database information page) * Set the `Wallet location` to the wallet location directory Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Connection-Types/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * Connection types [ Connection types ](./) Table of contents * Manage connection types * Change connection type * Create connection type * Edit connection type * Delete connection type * Default connection types * Comparison of default types * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Manage connection types * Change connection type * Create connection type * Edit connection type * Delete connection type * Default connection types * Comparison of default types 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Connection types Connection types control how DBeaver behaves when working with a database. They help define environment-specific behavior, such as: * transaction commit mode * SQL execution confirmation * automatic cleanup of idle transactions and connections * background color for easy environment recognition You can assign a connection type when creating or editing a connection. You can also define your own types with custom settings and colors. Connection type colors appear in the [Database Navigator](../Database-Navigator/), all related editors and tabs: ![](../images/ug/Colored_connections.png) ## Manage connection types¶ New connections use the **Development** type by default. You can switch to another default type, or create your own with custom settings. Info Learn more about default connection types. ### Change connection type¶ 1. In the [Database Navigator](../Database-Navigator/) or **Projects** view, select a connection 2. Open the connection properties by pressing `F4` or by right-clicking the connection and selecting **Edit connection** from the context menu 3. In the left pane, choose **General** 4. You'll find the **Connection type** field among the settings: ![](../images/ug/Connection-Properties-General.png) 5. To confirm the change, click **OK**. ### Create connection type¶ 1. Navigate to **Window - > Preferences -> Connections -> Connections types** ![](../images/ug/Properties-for-connection-types_window.png) 2. Click the **New** button (![](../images/ug/New-connection-type.png)) to add a connection type 3. Configure the settings for the new type: Setting | Description ---|--- **Identifier** | Unique ID for the type (used internally) **Name** | Display name shown in the UI **Description** | Short explanation of what this connection type is for **Color** | Visual indicator used to highlight connections of this type **Confirm SQL execution** | Show a confirmation dialog before running `INSERT`, `UPDATE`, or `DELETE` queries **Confirm data changes** | Ask for confirmation before saving changes to the database **Auto-commit by default** | Enable autocommit mode as the default behavior. [Learn more](../Auto-and-Manual-Commit-Modes/#auto-commit-mode) **Smart commit mode** | Start transactions automatically for data-changing statements. [Learn more](../Auto-and-Manual-Commit-Modes/#smart-commit-mode) **Return to auto-commit** | Re-enable autocommit after commit or rollback (only with smart commit) **End idle transactions (sec)** | Roll back and close transactions after being idle for the specified time **Close idle connection (sec)** | Disconnect after inactivity. Set to `0` to disable automatic disconnection Tip For embedded databases, **Close idle connection** is always ignored - they stay connected indefinitely. 4. Click **Apply** to save your changes, or **Apply and Close** to save and exit. Use **Restore Defaults** to undo all edits. ### Edit connection type¶ 1. Open the **connection properties** (`F4` or right-click the connection and select **Edit connection**) 2. On the **General** page, click **Edit** next to the **Connection type** field 3. Select a connection type and update its settings as described in Create connection type 4. Click **Apply** or **Apply and Close** to save changes. Use **Restore Defaults** to reset the type. Note The default connection types can't be edited. ### Delete connection type¶ 1. Open the **connection properties** (`F4` or right-click the connection and select **Edit connection**) 2. On the **General** page, click **Edit** next to the **Connection type** field 3. Select the connection type you want to remove, then click the **Delete** button (![](../images/ug/Delete-connection-type-button.png)) 4. In the confirmation dialog, click **Yes** to delete or **No** to cancel 5. Click **Apply** or **Apply and Close** to save your changes. ### Default connection types¶ DBeaver includes three built-in connection types: * **Development** – for local use * **Test** – for staging environments * **Production** – for live databases You can change the type assigned to a connection or create new types, and edit or delete existing ones. Tip Use connection types to clearly separate environments and avoid mistakes in production. #### Comparison of default types¶ Setting | **Development** | **Test** | **Production** ---|---|---|--- **Autocommit** | On | On | Off **Confirm SQL execution** | Off | Off | On **Confirm data change** | Off | On | On **Smart commit mode** | Off | Off | Off **Return to auto-commit** | On | On | Off **Auto-close transactions** | On | On | On **Idle transaction timeout** | 1800 seconds (30 minutes) | 900 seconds (15 minutes) | 600 seconds (10 minutes) **Auto-close connections** | On | On | On **Idle connection timeout** | 14400 seconds (4 hours) | 7200 seconds (2 hours) | 3600 seconds (1 hour) **Background color** | White | Olive green | Brick red Info If **Confirm SQL execution** is enabled for a connection type, DBeaver will ask for confirmation before running transactional queries like `INSERT`, `UPDATE`, or `DELETE`. ![](../images/ug/Confirm-query-execution-dialog.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Couchbase/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * Couchbase [ Couchbase ](./) Table of contents * Couchbase specialty * Setting Up * Couchbase connection configuration * Couchbase version 4 and below * Couchbase version 5 and above * Connection details * Couchbase driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Couchbase with DBeaver * Couchbase database objects * Couchbase features in DBeaver * Executing Couchbase queries * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Couchbase specialty * Setting Up * Couchbase connection configuration * Couchbase version 4 and below * Couchbase version 5 and above * Connection details * Couchbase driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Couchbase with DBeaver * Couchbase database objects * Couchbase features in DBeaver * Executing Couchbase queries 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Couchbase Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use Couchbase with DBeaver. Before you start, you must create a connection in DBeaver and select `Couchbase`. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the Couchbase server using a specific driver. It supports all versions of Couchbase, but the correct driver must be selected: use `Couchbase` for versions 4.x and earlier, and `Couchbase 5+` for version 5 and later. ![](../images/database/couchbase/couchbase-drivers.png) ## Couchbase specialty¶ Couchbase is a NoSQL database that diverges from traditional relational databases by storing data in JSON documents instead of tables. It employs N1QL, an SQL-like language specifically designed for querying JSON. In Couchbase, the concept typically known as databases in traditional systems is represented as Buckets. Unlike relational databases, Couchbase does not support some common features, such as triggers, stored procedures, views, complex joins, and the constructs of primary and foreign keys. For a more comprehensive understanding of Couchbase, please refer to the [official documentation](https://docs.couchbase.com/home/index.html). DBeaver that are compatible with Couchbase. ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, SSL, proxies, and Kubernetes. ### Couchbase connection configuration¶ #### Couchbase version 4 and below¶ In this subsection, we will outline the settings for establishing a direct connection to a Couchbase version 4 and below database using DBeaver. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/couchbase/couchbase-4-and-below-connection-main.png) Field | Description ---|--- **Node** | Specify the node in the Couchbase cluster to connect to. **Bucket** | Enter the name of the specific bucket within the Couchbase database to access. **Port** | Enter the port number for your Couchbase database. The default Couchbase port is `8091`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | Specify additional driver settings, such as Timeouts and SSL properties. #### Couchbase version 5 and above¶ The connection settings for these versions are similar to those for version 4 and below, with the notable exception that the **Bucket** setting is not used. ![](../images/database/couchbase/couchbase-latest-connection-main.png) ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Couchbase database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Couchbase driver properties¶ Couchbase is a NoSQL database system integrated into DBeaver through its API. While configuring connections to Couchbase in DBeaver, there are specific custom properties available, such as Timeouts and SSL settings. ![](../images/database/couchbase/couchbase-driver-properties.png) Property | Description ---|--- **Analytics Timeout** | The maximum time to wait for an analytics query before timing out. **Connection Timeout** | The time to wait for a connection to be established before timing out. **KV Timeout** | Default timeout for key-value operations. **Management Timeout** | Time to wait for management operations to complete. **Query Timeout** | The maximum time a query can run before it times out. **Search Timeout** | Time to wait for a search query to complete before timing out. **View Timeout** | Time to wait for a view query to complete before timing out. **Keystore file** | Path to the keystore file used for SSL connections. **Keystore password** | Password for the keystore file. **couchbase.sslEnabled** | A Boolean property to enable or disable SSL. Set to `true` to enable SSL. Tip All timeout settings are specified in milliseconds. ### Secure Connection Configurations¶ DBeaver supports secure connections to your Couchbase database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) Note For SSL configuration, the required properties are set within the DBeaver Driver settings. ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Couchbase with DBeaver¶ DBeaver provides a host of features designed for Couchbase databases. Couchbase uses a document-oriented approach, which means each piece of data, or "document" can have a unique structure. In DBeaver, you have the flexibility to view and edit the data within Couchbase buckets. This can be done similarly to how you would interact with tables in a traditional database, either through a grid view or as plain text. You can also work directly with JSON documents, making it easier to handle the different data formats that Couchbase supports. ### Couchbase database objects¶ DBeaver lets you view and manipulate a few Couchbase database objects. DBeaver has extensive support for various Couchbase metadata types, allowing you to interact with: * Buckets * Indexes * Cluster * Users ### Couchbase features in DBeaver¶ DBeaver also includes additional features compatible with Couchbase, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Data Visualization | [ERD Guide](../ER-Diagrams/) Data Management | [Working with JSON](../Working-with-XML-and-JSON/) ### Executing Couchbase queries¶ Couchbase uses N1QL (Non-First Normal Form Query Language), a query language similar to SQL, it lets you search through JSON documents with complex queries. For further details on N1QL, refer to the [official documentation](https://query-tutorial.couchbase.com/tutorial/#index). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Create-Connection/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * Create connection [ Create connection ](./) Table of contents * Creating a new database connection * Use the New Connection Wizard * Use the Menu Bar * Use the Database Navigator * Connection states overview * Tips * Connection management * Configuring Connection Settings * Additional Settings * Testing and Finalizing the Connection * Advanced Settings * Network Settings * Secure Storage with Secret Providers * Connection Details * Additional options * Driver Properties * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Creating a new database connection * Use the New Connection Wizard * Use the Menu Bar * Use the Database Navigator * Connection states overview * Tips * Connection management * Configuring Connection Settings * Additional Settings * Testing and Finalizing the Connection * Advanced Settings * Network Settings * Secure Storage with Secret Providers * Connection Details * Additional options * Driver Properties 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Create connection ## Creating a new database connection¶ DBeaver provides a wizard that guides you through the steps to create a connection. To create a connection, do one of the following: ### Use the New Connection Wizard¶ * Click the **New Connection Wizard** button ![](../images/ug/new-connection-wizard-button.png) in the [**Toolbar**](../Application-Window-Overview/#toolbar) or in the [**Database Navigator**](../Database-Navigator/) view toolbar. ![](../images/ug/Wizard-select-connection.png) Tip You can start creating a connection through AI with a short request in AI chat. See [View and editor actions](../View-and-Editor-Actions/) for supported commands. To quickly find the needed driver for your database connection, you can: * Type a hint in the text field above the list of drivers. * Browse the database sections to find the required database. * Search for a section using the **Search** field. * Sort the options by **Title/Score**. After selecting the required driver, click **Next**. ### Use the Menu Bar¶ * Click **Database** -> **New Database Connection** in the menu bar. * Press `Ctrl+N` -> **DBeaver**. Then, in the wizard, click **Database connection** and then click **Next**. * Click **File** -> **New** -> **DBeaver** and then, in the wizard, click **Database connection** and then click **Next**. ### Use the Database Navigator¶ * Right-click in the **Database Navigator** window area and select **Create** -> **Connection**. ### Connection states overview¶ Database connections in DBeaver might have the following states, each represented by a unique icon: Icon | Description ---|--- ![](../images/ug/PostgreSQL-icon.png) | Indicates a non-active connection. ![](../images/ug/DB-icon-not-connected.png) | Shows that network settings (like SSH tunnel) are specified but not connected. ![](../images/ug/DB-icon-connected.png) | Marks a successfully established connection. ![](../images/ug/Connection-error-icon.png) | Reflects a connection error. ### Tips¶ * If you cannot find a driver for your database, then probably there is no suitable driver, and you need to create one. Please see the [Driver manager](../Driver-Manager/) article. * Within the **New Connection Wizard** , you can select the [project](../Projects-View/) where the database will be saved. * For additional details on handling multiple connections with MFA authentication, see [Disable multiple connections opening for MFA authentication](../Separate-Connections/). * DBeaver supports database connections over IPv6, leveraging its Java-based architecture. * For insights into DBeaver's Java-based implementation, refer to the [Building from Sources](https://github.com/dbeaver/dbeaver/wiki/Build-from-sources) guide. * For more details on IPv6 support in Java, consult the [Java IPv6 Guide](https://docs.oracle.com/javase/8/docs/technotes/guides/net/ipv6_guide/). Important DBeaver includes OpenJDK, which is an open-source version of Java. This means you do not need to purchase a separate Java license to use DBeaver. ## Connection management¶ In DBeaver, connections are managed within the **Database Navigator** and **Projects** views. Here, you can: * **Edit Connections** : Refine connection details ([Editing Connections](../Edit-Connection/)). * **Rename/Delete** : Manage connections via context menu ([Database Navigator](../Database-Navigator/)). * **Connect/Disconnect** : Engage or disengage database connections (Connect to Database | [Disconnect from Database](../Disconnect-from-Database/)). ## Configuring Connection Settings¶ In the Connection Settings screen, on the **Main** tab, you need to set all primary connection settings. Here's what you typically need to configure: ![](../images/database/postgresql/postgre-connection-main.png) Setting | Description ---|--- **Host** | The address of the database server. **Port** | The port number for the connection. **Database Name** | The name of the specific database you want to connect to. **Username and Password** | The credentials required for authentication. This falls under the Authentication section, where different databases may use various types of authorizations. Common types include [Database Native](../Authentication-Database-Native/) and [DBeaver Profile](../Authentication-DBeaver-profile/). However, the number and type of connection properties are very dependent on the driver. For example, embedded drivers (such as SQLite, Derby Embedded, HSQLDB, H2 Embedded), unlike remote ones, require only the path to the database. For more detailed information about the settings specific to each driver, you can refer to the driver documentation articles available in the DBeaver documentation. ### Additional Settings¶ If necessary, you can specify advanced settings. See the Advanced Settings section below for more details. ### Testing and Finalizing the Connection¶ * **Test the Connection** : Click **Test Connection** to verify if the connection works. * **Finish** : Click **Finish**. The connection appears in the connections tree in the **Database Navigator**. By following these instructions, you can configure and establish a connection to your desired database within DBeaver. ## Advanced Settings¶ The Advanced Settings tab in the connection configuration process provides additional options to fine-tune your connection. Here's what you can configure: ### Network Settings¶ Setting | Description ---|--- **SSH Tunnel** | Configure an [SSH tunnel](../SSH-Configuration/) if your database requires a secure connection. **SOCKS Proxy** | [Set up a SOCKS proxy](../Proxy-configuration/) if you need to route the connection through a specific proxy server. **SSL Configuration** | Enable and [configure SSL](../SSL-Configuration/) if your connection requires encryption. **Kubernetes** ![](../images/commercial.png) | [Configure Kubernetes](../Kubernetes-configuration/) settings if your database is hosted within a Kubernetes cluster. **AWS SSM** ![](../images/commercial.png) | [Configure AWS SSM](../AWS-SSM-Configuration/). ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ### Connection Details¶ ![](../images/ug/Connection-details.png) Setting | Description ---|--- **Connection name** | Assign a specific name to the connection for easier identification. You can use variables in [SQL Editor](../SQL-Editor/), all connection parameters and in the driver properties. **Connection type** | Use [connection types](../Connection-Types/) to reflect environments like **Development** , **Test** , or **Production**. **Development** is the default type for new connections. You can also create your own with custom behavior and colors. **Descriptions** | Add descriptions for your connection for better understanding. **Navigator view** | Customize the [navigator view settings](../Database-Navigator/#simple-and-advanced-view). **Connection folder** | [Organize](../Database-Navigator/#group-database-objects-in-folders) your connections by placing them in specific folders. Tip Read more about variables in our [article](../Pre-configured-Variables/) ### Additional options¶ Setting | Description ---|--- **Security** | See the [Security restrictions article](../Managing-security-restrictions-for-database-connection/) for more details. **Filters** | Configure filters for your connection. See the [Filters article](../Configure-Filters/) for more details. **Virtual Model Editor** | Reset virtual model settings, including: \- All virtual constraints and foreign keys. \- All column transformers. \- All table row colorings. **Connection Initialization Settings** | Customize the initialization settings for your connection. See our [article](../Configure-Connection-Initialization-Settings/) for more details. **Shell Commands** | Configure shell commands for your connection. See the [Shell Commands article](../Working-with-Shell-Commands-in-DBeaver/) for more details. These advanced settings allow you to tailor the connection to fit specific requirements and preferences. Be sure to consult your database documentation or system administrator if you need guidance on the appropriate settings for your particular database and use case. ## Driver Properties¶ Each driver has its own set of additional properties. Refer to the driver documentation to get information about available properties and their values. Understanding and configuring these properties can help you optimize the connection according to the specific requirements and behavior of the database driver you are using. ![](../images/ug/Driver-properties.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Creating-Indexes/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * Creating indexes [ Creating indexes ](./) Table of contents * Create * Saving changes * Modify * Delete * Restrictions * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create * Saving changes * Modify * Delete * Restrictions 1. [DBeaver](/docs/dbeaver) 2. [Tutorials](/docs/dbeaver/New-Table-Creation) 3. Table Creation # Creating indexes In the process of creating [tables](../New-Table-Creation/) in a database, an integral part is the creation of indexes. Indexes are tools that can significantly enhance the performance of your database. They are designed to speed up the retrieval of data from the tables, making them particularly useful in large databases where without them, searches could be time- consuming. Indexes work by providing a more direct path to the data, reducing the need for the database to scan the entire table. They can be created on one or more [columns](../Creating-columns/) of a table, and when a query is made, the database can use the indexes to find the data more quickly. However, while indexes can improve the speed of data retrieval, they can also slow down data modification operations such as `INSERT`, `UPDATE`, and `DELETE`, as the index must also be updated. Therefore, it's crucial to strike a balance between the number of indexes and the frequency of data modification in your database. This article will guide you through the process of creating, modifying, and deleting indexes using the DBeaver. It will also discuss the restrictions you need to be aware of when working with indexes, such as the impact on performance, storage considerations, and restrictions related to null values and certain data types. ## Create¶ 1. You can start the process of creating a new index in three ways: 2. Using the **[Properties editor](../Properties-Editor/)** : Open the Properties Editor and navigate to the **Indexes** tab of the corresponding table. ![](../images/tutorial_images/14_Create_Index.png) * Using the **[Database Navigator](../Database-Navigator/)** : Navigate to the database where the table you want to add a index to is located. Find and select the table for which you want to create a new index. Within the selected table, you'll find a folder named **Indexes**. * Additionally, to create a new index, you can utilize the **Create New Index** button ![](../images/tutorial_images/New_Index_Button.png) located at the bottom of the **Properties editor**. * Depending on the method you chose in step 1, either right-click on the window (in the **Properties Editor**) or within the **Foreign Keys** folder (in the **Database Navigator**), and select **Create New Index**. If you're using the third method, simply click the **Create New Index** button. This will open a new window where you'll be able to customize the index's settings to suit your needs. ![](../images/tutorial_images/14a_Index_Parameters.png) Field | Description ---|--- **Unique** | If set to unique, the index ensures that all entries in the indexed column(s) are distinct. This can limit data entry if values must be unique. **Columns** | This setting allows you to select one or more columns for the index. Note In addition to creating a simple index on a single column, DBeaver also provides the option to create a composite index. A composite index is an index that is built on several table columns. This type of index can significantly boost query execution speed when dealing with multiple-column conditions. It's recommended to put unique fields at the end of the composite index to maximize its efficiency. 1. After you've chosen the column(s) for your index and configured any additional settings, you can finalize the creation of the index by clicking **OK**. ### Saving changes¶ Once you have configured the index properties, it is essential to save these changes to the database. Until you commit your modifications, the new index will only exist within DBeaver and will not be added to the actual database table. Here are three options for committing the changes: * Click on **File** -> **Save** -> **Persist**. * Select the desired table in the **Database Navigator** and press `Ctrl+S` (or `CMD+S` for Mac OS), choose **Persist** to save the changes. * Utilize the **Save** button ![](../images/tutorial_images/10b_SaveButton.png) located at the bottom of the **Properties editor** and press **Persist** to save the changes. ## Modify¶ As your database evolves, there might be a need to modify the properties of your indexes. This could involve changing the indexed columns, adjusting the uniqueness constraint, or renaming the index. DBeaver provides the flexibility to make these modifications as required. Here's the process: * **Properties Editor** : Open the **Properties Editor** by double-clicking on the table name. Within the selected table, you'll find a folder named **Indexes**. Right-click on the index you want to modify and select **View Index**. * **Database Navigator** : In the Database Navigator, select the appropriate database and table. Within the selected table, you'll find a folder named **Indexes**. Right-click the index and select **View Index**. * **Bottom Menu** : In the **Properties Editor** interface, use the **View Indexes** button ![](../images/tutorial_images/View_column_button.png) to open the properties of the selected index in the **Editor panel**. ![](../images/tutorial_images/14b_View_Index.png) ## Delete¶ 1. You can delete an index either through the **Properties Editor** or the **Database Navigator** : 2. Using the **Properties Editor** : Open the **Properties Editor** , navigate to the **Indexes** tab of the corresponding table, and find the index you want to delete. ![](../images/tutorial_images/14c_Delete_Index.png) * Using the **Database Navigator** : Navigate to the database where the table with the index is located. Open the **Indexes** folder, and find the index you want to delete. * To delete an index, right-click on the index's name and select **Delete** , or you can select the necessary index and press the `Delete` key, or **Delete button** ![](../images/tutorial_images/Delete_button.png) (in the **Bottom Menu** of the **Properties Editor**). * A confirmation dialog will appear, asking you to confirm the deletion. Before proceeding, ensure that you've selected the correct index for deletion. * After confirming the deletion, you'll need to persist the changes to apply them to the database. ## Restrictions¶ * Unique indexes created due to a primary key or unique constraint can't be deleted. Instead, remove the constraint. This action removes the uniqueness requirement for column values involved in the constraint expression and deletes the corresponding unique index. * **Unique Indexes** : These enforce uniqueness on the indexed column(s), which can limit data entry if values must be distinct. * **Performance Impact** : Indexes can improve query speed, but they slow down data modification operations (`INSERT`, `UPDATE`, `DELETE`) as the index must also be updated. * **Storage** : Indexes consume disk space. This might become significant if there are many indexes or the table is large. * **Null Values** : Depending on the database system, there may be restrictions related to indexing null values. * **Data Types** : Certain data types might not be indexable or may require specific index types. **Further Reading:** [New Table Creation](../New-Table-Creation/) | [Creating columns](../Creating-columns/) | [Implementing Constraints](../Implementing-Constraints/) | [Utilizing foreign keys](../Utilizing-Foreign-Keys/) | Creating indexes | [Incorporating triggers](../Incorporating-Triggers/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Creating-columns/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * Creating columns [ Creating columns ](./) Table of contents * Create * Saving changes * Modify * Delete * Restrictions * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create * Saving changes * Modify * Delete * Restrictions 1. [DBeaver](/docs/dbeaver) 2. [Tutorials](/docs/dbeaver/New-Table-Creation) 3. Table Creation # Creating columns As you delve deeper into the intricacies of table structures, understanding columns and their functionalities becomes crucial. In DBeaver, columns are fundamental components of tables, which in turn are housed within databases. Before you can create columns, you must first establish a [database](../Create-Connection/) and a [table](../New-Table-Creation/). Columns in DBeaver are versatile and customizable. You can create new columns, modify their settings, and even delete them when necessary. Each column in a table has a specific data type, dictating the kind of data it can store. You can also enforce rules on columns such as nullability, unique constraints, check constraints, and default values. These rules are essential to maintain data integrity, accuracy, and reliability in your database. Beyond these basic operations, you can perform more advanced tasks with columns. You can rename columns, change their data types, adjust permissions, and add comments. All databases may not support some of these operations, so it's essential to be aware of the specific capabilities of your database system. This guide will walk you through the process of creating, modifying, and deleting columns, as well as customizing their settings to suit your needs. ## Create¶ Creating a new column in DBeaver involves a series of steps that guide you through the process. Here's how you can do it: 1. Go to the **Columns** tab in the **[Properties editor](../Properties-Editor/)** , right-click on the pane of the object's sub-entities, and select **Create New Column** from the context menu. ![](../images/tutorial_images/4_RightClick_CreateNewColumn.png) * Also you can also add a new column by expanding the table view in the **[Database Navigator](../Database-Navigator/)** and selecting **Create New Column**. ![](../images/tutorial_images/4a_ExpandTable_CreateNewColumn.png) * Another method to create a new column is by utilizing the **Create New Column** button ![](../images/tutorial_images/4d_Column_Button.png) located at the bottom of the **[Editor panel](../Data-Editor/)**. * When creating a new column, you'll be presented with the **Edit Attribute** window. Here, you can customize the column's settings to suit your needs. You can adjust the **Name** , **Data type** , **Identity** , **Collation** , **Not null** , **Default** , add a **Comment** as needed, and configure **Keys** for the column. ![](../images/tutorial_images/5_Column_Edit.png) Field | Description ---|--- Name | Specify the name of the column. Data type | Select the type of data the column will store. Identity | Set the column as an identity column, which will auto-increment its value with each new row. Collation | Set the collation for the column, which determines how data in the column is sorted and compared. Not null | Enforce that the column must always contain a value. Default | Set a default value for the column, which will be used when no value is specified for the column during insertion. Comment | Add a comment for the column, which can be helpful for documentation purposes. Unique | Select this checkbox to enforce that the values in the column must be unique. Type | Choose the type of key for the column: `Primary Key`, or `Unique Key`. Name | Specify the name of the key, which is useful for identification in constraints and indexing. ### Saving changes¶ Saving a column in DBeaver is an essential and simple operation. After you've configured the column properties, it's vital to persist these changes to the database. Until you save your modifications, your new column only exists within DBeaver and hasn't been added to the actual database table. Here are the three options for committing the changes: * Click on **File** -> **Save** -> **Persist**. * Select the desired table in the **Database Navigator** and press `Ctrl+S` (or `CMD+S` for Mac OS), choose **Persist** to save the changes. * Utilize the **Save** button ![](../images/tutorial_images/10b_SaveButton.png) located at the bottom of the **[Editor panel](../Data-Editor/)** and press **Persist** to save the changes. ## Modify¶ As your database evolves and your needs change, you may find it necessary to modify the properties of your columns. Whether it's renaming a column, changing its data type, adjusting its nullability, or updating its permissions, DBeaver provides you with the flexibility to adapt your columns to your changing requirements. Modifying columns is a crucial aspect of database management, allowing you to ensure that your columns continue to serve their intended purpose effectively. Here's how you can modify a column in DBeaver: * Via the **Properties Editor** : You can double-click on the table name to open the **Properties Editor**. In this window, you can see all the columns of the table. Right-click on the column you want to modify and select **View Column**. * Via the **Database Navigator** : Go to the **Database Navigator** menu, and choose the proper database and column to modify its settings. Right-click the column and select **View Column**. * Via the **Bottom Menu** : In the bottom menu of the **Properties Editor** interface, there is a **View Column** button ![](../images/tutorial_images/View_column_button.png). Clicking this button will open the properties of the currently selected column in the **Editor panel** , allowing you to modify its settings. Note Not all databases support all types of column modifications, so always check the specific capabilities of your database system. ## Delete¶ 1. You can delete a column either through the **Properties Editor** or the **Database Navigator** : 2. Using the **Properties Editor** : Open the Properties Editor, navigate to the **Constraints** tab of the corresponding table, and find the column you want to delete. 3. Using the **Database Navigator** : Navigate to the database where the table with the column is located. Find and select the table, open the **Columns** folder, and find the column you want to delete. 4. To delete a column, right-click on the column's name and select **Delete** , or you can select the necessary column and press the `Delete` key, or **Delete button** ![](../images/tutorial_images/Delete_button.png) (in the **Bottom Menu** of the **Properties Editor**). 5. A confirmation dialog will appear, asking you to confirm the deletion. Before proceeding, ensure that you've selected the correct column for deletion. 6. After confirming the deletion, you'll need to persist the changes to apply them to the database. ![](../images/tutorial_images/4c_Delete_Column.png) Once a column is deleted, all the data stored in that column will be lost. Furthermore, there are several restrictions and considerations to keep in mind when deleting columns: Limitations | Description ---|--- **Data Loss** | As mentioned, deleting a column will permanently remove all data stored in that column. Make sure to back up any important data before proceeding with the deletion. **Primary Key Columns** | If the column you want to delete is a primary key column, you must first remove its primary key constraint within the table properties. Primary key columns are used to identify each row in the table uniquely, and deleting them without removing the constraint can cause issues. **Referential Integrity** | If the column you want to delete is referenced by other tables in the database (i.e., it's a foreign key), you may not be able to delete the column without first deleting or modifying the referencing tables. This is to maintain referential integrity in the database. **Database Support** | Not all databases support the ability to delete columns. Always check the specific capabilities of your database system. ## Restrictions¶ When working with columns in DBeaver, it's important to understand the various restrictions that can be applied to them. These restrictions are not limitations but rather rules that help ensure the integrity, accuracy, and reliability of the data stored in your database. They dictate what data can be stored in a column, how it's treated, and how it interacts with other data in the database. Let's take a closer look at these restrictions: * **Data Type** : Each column in a table has a specific data type. The type of data that can be stored in a column is dictated by its data type. * **Nullability** : By default, columns can hold **NULL**. However, by specifying **NOT NULL** during column creation, you can enforce that every row must contain a value for that column. * **Unique Constraint** : A unique constraint ensures that all values in a column are distinct. Duplicate entries are not permitted. * **Check Constraint** : A check constraint enables you to specify a condition on a column. Every value added to the the column must satisfy this condition. * **Default Value** : A column can be given a default value. If no value is specified during data insertion, the column uses the default. **Further Reading:** [New Table Creation](../New-Table-Creation/) | Creating columns | [Implementing constraints](../Implementing-Constraints/) | [Utilizing foreign keys](../Utilizing-Foreign-Keys/) | [Creating indexes](../Creating-Indexes/) | [Incorporating triggers](../Incorporating-Triggers/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Custom-Diagrams/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * Custom diagrams [ Custom diagrams ](./) Table of contents * Create a custom diagram * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create a custom diagram 1. [DBeaver](/docs/dbeaver) 2. Entity relation diagrams # Custom diagrams You can create custom Diagrams that can contain any tables, relations and notes. However, even custom diagrams may contain only real existing database entities (tables). ![](../images/ug/Custom-diagram.png) ## Create a custom diagram¶ You can create a custom diagram in one of the ways: 1. On the DBeaver main menu, click **File - > New**. Then in the new diagram wizard, click **DBeaver - > ER Diagram**, and then **Next** : ![](../images/ug/ERD-Wizard.png) 2. In the [Project Explorer](../Project-Explorer/) view, right-click the **Diagrams** node and then click **Create New Diagram** on the context menu. ![](../images/ug/ERD-Create-from-Project-Explorer.png) In both cases, in the Diagram Create Wizard, specify the diagram name and (optional) choose the initial diagram contents (set of tables): ![](../images/ug/ERD-Create-custom-diagram.png) The new diagram appears in a separate editor. Now you can drag-n-drop any number of tables into it. You can add tables from different connections as well as from different database types (for example, combine Oracle and MySQL tables in one and the same diagram). You can also add notes and custom relations (associations) using the ERD palette on the left side of diagram tab - see details in the [Diagrams](../ER- Diagrams/) article. For example, to create a diagram similar to the one shown at the beginning of this article, you need to: 1. Add required tables and relationships between them and move them around to create a well-shaped structure (see _Structure Adjustment_ section of the [Diagrams](../ER-Diagrams/) article). 2. Add notes (see the _Notes_ section of the [Diagrams](../ER-Diagrams/) article). 3. Stretch the notes to cover the intended tables, then send the notes to the back, and then set a color to the tables and notes (see the _View Adjustment_ section of the [Diagrams](../ER-Diagrams/) article). Undo/redo functions are fully supported in diagram editing. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Customer-technical-support-information/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * Customer technical support [ Customer technical support ](./) Table of contents * Accessing technical support * End of support * [ FAQ ](../FAQ/) Table of contents * Accessing technical support * End of support 1. [DBeaver](/docs/dbeaver) 2. About DBeaver # Customer technical support ## Accessing technical support¶ DBeaver ensures all users receive technical support for the duration of their paid license. Tickets for technical support can be submitted via the [website](https://dbeaver.com/tickets). ## End of support¶ Please be aware that technical support ends alongside the expiration of the license period. This occurs even though DBeaver remains usable for users with a Perpetual license type. Tip See [details](../Differences-between-license-types/) about the differences between license types. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/DB-Full-Text-Search/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * Full-text search database [ Full-text search database ](./) Table of contents * Use full text search * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Use full text search 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Search # Full-text search database ## Use full text search¶ To do a full text search in the database, click the arrow next to the Search icon in the main toolbar and then click **File Search** on the dropdown menu: ![](../images/ug/Full-Text-Search-menu.png) Alternatively, you can click the **Search** button on the main menu and then click the **DB Full-Text** tab in the Search window: ![](../images/ug/Full-Text-Search-window.png) Now you need to choose the database connection or database objects against which to run the search – expand the tree in the **Databases** field to the database connections level or further down and select the checkboxes next to the required connections or database objects. Note The **Search** button is enabled only when you select the right level of checkboxes – database connections or lower nodes. You can apply a case-sensitive search, fast search and search in numbers and LOBs. After you click **Search** , the results will open in [Search](../Search- Tool/) view: ![](../images/ug/Search-results-view.png) Double-clicking a row in the Search view opens the respective object in a dedicated [Database Object editor](../Database-Object-Editor/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/DB-Metadata-Search/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * Metadata search [ Metadata search ](./) Table of contents * Use metadata search * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Use metadata search 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Search # Metadata search ## Use metadata search¶ To search for database metadata, click the arrow next to the **Search** button in the main toolbar and then click **DB Metadata Search** on the dropdown menu: ![](../images/ug/DB-Metadata-Search-Menu.png) Alternatively, you can click the **Search** button on the main menu and then click the **DB Metadata** tab in the Search window: ![](../images/ug/DB-Metadata-Search-window.png) Now you need to choose the database connection against which to run the search. You only need to select the database connection(s) in the **Objects Source** field. In the **Object Types** field, you can select the database objects among which DBeaver will run the metadata search – select or clear the checkboxes. You can specify that the object name starts with, contains or is similar to the search combination (**Name match** field). You can also set the maximum number of results to display (**Max results** field) and apply **Case-sensitive** search. After you click **Search** , the results will open in a [Search](../Search- Tool/) view: ![](../images/ug/Metadata-search-results-view.png) Double-clicking a row in the Search view opens the respective object in a dedicated [Database Object editor](../Database-Object-Editor/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/DBeaver-release-cycles/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * Release cycles [ Release cycles ](./) Table of contents * Release cycles * Release schedule * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Release cycles * Release schedule 1. [DBeaver](/docs/dbeaver) 2. About DBeaver # Release cycles ## Release cycles¶ DBeaver releases updates on a structured schedule, providing users with regular enhancements, new features, and fixes. ## Release schedule¶ * **Regular releases** : DBeaver releases a new stable version every three months, resulting in four major updates annually. For detailed information, please refer to [DBeaver's official release schedule](https://dbeaver.com/future-releases/). * **Early Access (EA) versions** : Additionally, DBeaver provides Early Access (EA) versions every two weeks. These versions allow users to engage with upcoming features and changes, offering feedback to help refine these enhancements before their official release. Important The EA version may not be as stable as the regular releases. Please use EA versions with caution. For release notes and to download the current release, EA version, or archive releases, please visit [DBeaver's Download page](https://dbeaver.com/download/). The GitHub repository also hosts all release notes, accessible at [GitHub](https://github.com/dbeaver/dbeaver/releases). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Dashboards/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * Dashboards [ Dashboards ](./) Table of contents * Dashboard Types * Connection Dashboards * Project Dashboards * Managing Dashboard panel * Opening Dashboard panel * Adding charts * Removing charts * Resetting charts * Changing chart representation * Adjusting chart configuration * Setting connection preferences * Detaching charts * Changing chart view * Copying chart to clipboard * Saving charts * Printing charts * Zooming * Managing charts * Creating charts * To create a chart from scratch * To create a chart from a template * Editing charts * To edit a chart's configuration * Deleting Dashboards * To delete a dashboard * Managing web-based dashboards * Web charts * Tableau charts * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Dashboard Types * Connection Dashboards * Project Dashboards * Managing Dashboard panel * Opening Dashboard panel * Adding charts * Removing charts * Resetting charts * Changing chart representation * Adjusting chart configuration * Setting connection preferences * Detaching charts * Changing chart view * Copying chart to clipboard * Saving charts * Printing charts * Zooming * Managing charts * Creating charts * To create a chart from scratch * To create a chart from a template * Editing charts * To edit a chart's configuration * Deleting Dashboards * To delete a dashboard * Managing web-based dashboards * Web charts * Tableau charts 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Dashboards Note This feature is available in Community, [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. **Dashboards** tool allows DBAs and programmers to quickly identify performance, disk space issues, the number of connections, and other important KPIs associated with a single [database connections](../Create-Connection/). By default, DBeaver comes equipped with predefined charts sets for several popular databases. These include: Database | Predefined charts ---|--- **Exasol** | Connections, User activity. [MySQL](../Database-driver-MySQL/) | InnoDB data, InnoDB memory, Key Efficiency, Queries, Server sessions, Traffic. [Oracle](../Oracle/) | CPU usage, Global Query Stats, IO Stats, Memory usage, Memory usage by components. [PostgreSQL](../Database-driver-PostgreSQL/) | Block IO, Server sessions, Transactions per second. [BigQuery](../Database-driver-BigQuery/) | Bytes Processed for Project. In addition to these predefined charts, DBeaver also supports the creation of custom charts. For more information on customizing a dashboard panel, refer to the Managing Dashboards section. ## Dashboard Types¶ You can create and open two types of dashboards: Connection dashboards and Project dashboards. ### Connection Dashboards¶ Connection dashboards are specific to individual database connections. These dashboards allow you to monitor performance, disk space, the number of connections, and other critical metrics related to the connected database. Any changes or customizations made to a connection dashboard are temporary and specific to the session of the database connection. For instructions on managing dashboards, see the Managing Dashboard panel section. ### Project Dashboards¶ Project dashboards can include web-based dashboards and are saved within the active [Project](../Projects/). For instructions on adding and configuring these dashboards, refer to the Managing web-based dashboards section. ## Managing Dashboard panel¶ The Dashboards panel aggregates a collection of real-time displays that update continuously. Each display consists of ongoing SQL `SELECT` queries and dynamically generated charts, ensuring that data visualizations are always current. ### Opening Dashboard panel¶ To open the Dashboards panel: * Press the **Open Dashboard** button ![](../images/ug/dashboards/Open_Dashboard_icon.png) on the top toolbar. The default configuration of the dashboards panel for the current database connection will appear. Note The toolbar is customizable. For further information, refer to [Toolbar Customization](../Toolbar-Customization/) article. * You can also right-click a connection in **Database Navigator** , then navigate to **Tools - > Open Dashboard**, or use the keyboard shortcut `Ctrl+Alt+Shift+B` to open the Dashboards panel. ![](../images/ug/dashboards/Open_Dashboard_Menu_Option.png) Once you open the Dashboards panel, the following controls are available on the toolbar: Name | Icon | Description ---|---|--- **Settings** | ![](../images/ug/dashboards/Dashboard_Settings_icon.png) | Opens the dashboard's configuration. **Add chart** | ![](../images/ug/dashboards/Dashboard_Add_icon.png) | Opens a window where you can select which chart to add to the dashboard. **Show charts catalog** | ![](../images/ug/dashboards/show-charts-catalog-button.png) | Opens the side menu displaying available charts. **Delete dashboards** | ![](../images/ug/dashboards/Dashboard_Delete_icon.png) | Deletes the Dashboard panel. Default dashboards cannot be permanently deleted and will be restored automatically if removed; however, custom dashboards, once deleted, must be manually recreated. ### Adding charts¶ To add a chart to the Dashboards panel: * Press the **Add chart** button ![](../images/ug/dashboards/Dashboard_Add_icon.png) on the Dashboards panel's toolbar, choose one of the charts from the list of available charts, and press **Add** button or double-click on it, or press `Enter`. * You can also right-click in any place of the Dashboards panel and then select the **Add chart** option. * Alternatively, press the **Show charts catalog** button ![](../images/ug/dashboards/show-charts-catalog-button.png) on the Dashboards panel's toolbar to open the side menu displaying available charts. From this menu, you can add a chart to the dashboard by dragging it to the Dashboard panel, double-clicking on it, or press `Enter`. ### Removing charts¶ To remove a chart from the Dashboards panel: * Press the **Remove chart** button ![](../images/ug/dashboards/Dashboard_Remove_icon.png) located on the chart panel's toolbar. * Select the **Remove chart** option from the chart's context menu. ### Resetting charts¶ If you want to restart a chart's calculations, you can reset it. To reset a chart: * Right-click on the chart and select the **Reset dashboards** option ![](../images/ug/dashboards/Dashboard_Reset_icon.png). * Left-click on the chart and press the **Reset dashboards** button on the chart panel's toolbar. ### Changing chart representation¶ To adjust chart representation settings: * Right-click on a chart and select the **Settings** menu option ![](../images/ug/dashboards/Dashboard_Settings_icon.png) on the Dashboards toolbar. * Press the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) located on the chart panel's toolbar. Then, in the opened dialog, change the parameters you want. ![](../images/ug/dashboards/RepresentationSettings_DialogBox.png) Parameter | Description ---|--- **Name** | Defines the name of a chart. **Description** | Defines the chart's description. Use this field to make it easy to understand what kind of information the chart represents. **Update periods(ms)** | Defines how often chart's rendering should be updated. The default value is 1000 ms. **Maximum items** | Defines the maximum number of fetched items. The default value is 300. **View** | Defines the visual representation of the chart. The following options are available: Bar, Pie, Time series. **Show legend** | If this check-box is selected, the legend will be displayed on the chart. **Show grid** | If this check-box is selected, the grid will be displayed on the chart. **Show domain axis** | If this check-box is selected, the domain axis will be displayed on the chart. **Show range axis** | If this check-box is selected, the range axis will be displayed on the chart. ### Adjusting chart configuration¶ To adjust a chart's configuration settings: * Right-click on a chart and select the **Settings** menu option ![](../images/ug/dashboards/Dashboard_Settings_icon.png) on the Dashboards toolbar. * Press the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) located on the chart panel's toolbar. in the opened dialog box, press the **Configuration** menu option. ![](../images/ug/dashboards/ConfigurationSettings_DialogBox.png) The following chart parameters can be configured: Parameter | Description | Available values ---|---|--- **ID** | Unique identifier for the chart. This is typically a structured string. | **Name** | The name of the chart, which describes its function or the data it displays. | **Display Name** | A user-friendly name for the chart that can be displayed in the user interface. | **Description** | A brief explanation of what the chart displays, including the type of data and its use case. | **Database** | Specifies the type of database connected to the chart. | **Data type** | The nature of data used in the chart, which indicates continuous data points over time. | `timeseries`, `statistics`, `provided` **Calc type** | The calculation type for data processing, which indicates direct value use without derivatives. | `value`, `delta` **Value type** | The data unit measure, useful in contexts like memory usage. | `decimal`, `integer`, `percent`, `bytes` **Interval** | The time interval for data refresh or update, indicating rapid data refresh cycles. | `millisecond`, `second`, `minute`, `hour`, `day`, `week`, `month`, `year` **Fetch type** | Method of data retrieval, indicating row-wise fetching of data. | `columns`, `rows`, `stats` **Queries** | SQL query used to fetch data for the chart, should correctly reflect conditions and targets specific data. | **Default view** | Default visual representation style of the chart, which provides a pie chart of the data. | `Bar`, `Pie`, `Time series`, `Browser` **Update period (ms)** | Frequency of chart updates in milliseconds, indicating how often the chart data gets refreshed. | **Maximum items** | The maximum number of data points or items to display at any given time on the chart. | Note Predefined charts are read-only and cannot be re-configured, but you can copy them and use them as templates to create new charts with any query and other settings. To learn about creating new charts, see the Managing charts section. ### Setting connection preferences¶ By default, if there is no active connection to the database and you open its Dashboards panel, all the charts on the panel will be empty. You can force a database connection on the Dashboard panel's activation by pressing the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) on the dashboards panel's toolbar and then selecting the **Connect to database on activation** checkbox. ### Detaching charts¶ If you have several monitors and would like to place a chart on a separate screen, you can either detach the whole Dashboards panel or a single chart, and drag-and-drop them to any place you want. * To detach the whole Dashboard panel, right-click on the dashboard's tab name and select the **Detach** menu option. * To detach a single chart: * Double left-click over it. * Select the **View in popup** button ![](../images/ug/dashboards/view-in-popup-button.png). ### Changing chart view¶ You can change the representation of a dashboard and view it as a **Pie** , **Bar** , or **Time series**. To change the dashboard view: * Right-click on it and select the **View as** menu option. * Press the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) located on the chart panel's toolbar and select the **View** menu option. ### Copying chart to clipboard¶ To copy a chart onto the clipboard, right-click on the chart and use the **Copy to Clipboard** menu option. The screenshot of the dashboard will be placed onto the clipboard. ### Saving charts¶ If you want to save a screenshot of a chart locally in `PNG` format, right- click on it and select the **Save as...** option in the context menu displayed. ### Printing charts¶ If you want to print out a screenshot of a dashboard, right-click the dashboard to be printed and select the **Print...** option. ### Zooming¶ For **Time series** and **Bar** chart representations, the following zooming options are available on the dashboard's context menu: * Zoom In * Zoom Out * Zoom Reset ## Managing charts¶ You can extend the list of predefined default dashboards by creating your own custom dashboards. This section describes dashboards' list management. ### Creating charts¶ You can create a new custom dashboard either from scratch or from any existing dashboards. #### To create a chart from scratch¶ 1. Press the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) on the Dashboards panel toolbar. 2. In the opened dialog box, click the **Manage charts...** button. 3. In the **Manage dashboard charts** window, click the **New Database chart** button. 4. Set up all configuration parameters as required and press **OK**. Tip To learn more about the chart's configuration parameters, see [Adjusting chart Configuration](./#adjusting-chart-configuration). ![](../images/ug/dashboards/New_dashboard_from_scratch.png) #### To create a chart from a template¶ 1. Press the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) on the Dashboards panel toolbar. 2. In the opened dialog box, click the **Manage charts...** button. 3. In the **Manage dashboard charts** window, select any of the existing charts from the list and click **Copy**. 4. Adjust all configuration parameters as required and press **OK**. ### Editing charts¶ If you need to change the chart's name, ID, or any other configuration setting, you can edit a chart. Note Only custom charts can be edited. #### To edit a chart's configuration¶ 1. Press the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) on the Dashboards panel toolbar. 2. In the opened dialog box, click the **Manage charts...** button. 3. In the **Manage dashboard charts** window, select any of the custom charts from the list and click **Edit...**. 4. Adjust all configuration parameters as required and press **OK**. ### Deleting Dashboards¶ Note Predefined charts cannot be deleted, but any custom dashboards can be deleted. If you want to delete a dashboard, follow the steps described below. #### To delete a dashboard¶ 1. Press the **Settings** button ![](../images/ug/dashboards/Dashboard_Settings_icon.png) on the Dashboards panel toolbar. 2. In the opened dialog box, click the **Manage charts...** button. 3. In the **Manage dashboard charts** window, select any of the custom charts from the list and click **Delete**. ## Managing web-based dashboards¶ ### Web charts¶ DBeaver allows the integration of custom web-based charts into your dashboards, enabling a flexible way to display data from any accessible URL. To add a web chart to a dashboard, follow these steps: 1. Click on the arrow next to the **Open Dashboard** button ![](../images/ug/dashboards/Open_Dashboard_icon.png) on the top toolbar, and select **new project dashboard**. Note The toolbar is customizable. For further information, refer to [Toolbar Customization](../Toolbar-Customization/) article. 1. In the new dashboard, navigate to **Add chart - > Manage charts**. 2. Choose **Web** and click on the **New Web chart** button. 3. You will be prompted to enter `ID`, `Name`, `Description` and the `URL` of the Web chart. ![](../images/ug/dashboards/web-based-charts.png) Tip The URL can point to any web-hosted visualization tool, such as Grafana pages with specific metrics. You can also use DBeaver's pre-configured variables in the URL. For more information on existing variables, see the [Pre-configured variables](../Pre-configured-Variables/) article. ### Tableau charts¶ DBeaver supports integrating Tableau charts for enhanced data visualization. Note You must be logged into your Tableau account through DBeaver. For more details on setting this up, see our [article](../Tableau-integration-in-DBeaver/). To access and use Tableau charts, follow these steps: 1. Click on the arrow next to the **Open Dashboard** button ![](../images/ug/dashboards/Open_Dashboard_icon.png) on the top toolbar, and select **new project dashboard**. 2. Enter a **Name** and **ID** for your dashboard; this will open the Dashboard panel. 3. On the right side of the Dashboard panel, Tableau charts will be available in a dropdown menu. 4. Select the desired chart and either drag it to the left side of the Dashboard panel or double-click on the chart to add it. ![](../images/ug/dashboards/tableau-charts.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-Editor-preferences/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * Data Editor preferences [ Data Editor preferences ](./) Table of contents * Appearance * Grid * Grid appearance * Grid behavior * JSON * Plain text * Binary editor * Data formats * Dictionaries * GIS viewer * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Appearance * Grid * Grid appearance * Grid behavior * JSON * Plain text * Binary editor * Data formats * Dictionaries * GIS viewer 1. [DBeaver](/docs/dbeaver) 2. Data Editor # Data Editor preferences You can fully customize how data is displayed and edited in the [Data Editor](../Data-Editor/). Use these settings to change the appearance, behavior, formatting, and handling of different data types. Tip You can configure Data Editor preferences directly in the configuration file, without starting the application. For details, see [how to manage preferences via config files](../Admin-Manage-Preferences/). All preferences are available at **Window - > Preferences -> Editors -> Data Editor**. Customize general behavior of the Data Editor:: Setting | Description ---|--- ResultSet fetch size | Number of rows fetched from the database in one batch. Affects performance Auto-fetch next segment | Automatically loads the next data segment when the current one is fully processed or viewed Refresh data on next page reading | Refreshes the data when moving to the next page Use SQL to limit fetch size | Modifies the source SQL query to scroll through or limit results. This is typically achieved using the `LIMIT`/`OFFSET` SQL clause Automatic Row Count | Counts the number of rows only once when you first open the data viewer. It doesn't update automatically after that. Ordering mode | Specifies how sorting is applied to query results: \- `Adaptive` (default) chooses the best strategy depending on context; \- `Always on client` sorts data after it's fetched; \- `Always on server` enforces sorting in the SQL query Default ordering | Specifies the default ordering of records. By default, the ordering is not changed, and the result set is displayed in the order in which it was fetched. Otherwise, this option has no effect if the table doesn't have a primary key. Please note that setting this option may result in an additional query to the database because information about constraints is unavailable beforehand Query cancel timeout (ms) | Defines the duration (in `milliseconds`) the system waits before cancelling a non-responsive query Always use subselect for filters | Forces the usage of subqueries when applying filters to the data Use column names instead of column labels | Prioritizes column names over column labels when referencing data Use fetch-size | Overrides the default JDBC fetch size. This is an advanced option and should only be changed if you know how the driver handles data fetching. Use all table columns as a key upon saving | Forms a virtual composite key using all table columns for data saving. If set to `true`, this will determine the action taken if a key element is missing. If set to `false`, no action will be taken when a key element is missing Disable data editing | Prevents data modification when a primary key is absent. This setting defines the action taken when the assumed primary key is missing Keep open cursors in SQL editor | Closes the result set after a selection. To view a cursor column value, the option should be enabled Insert new rows after current | Places newly inserted rows immediately following the currently selected row Refresh after update | Automatically refreshes the data after making changes Use navigator filters | Employs filters in the navigator to refine the displayed data Activate advanced datetime editor | Enables the advanced datetime editor in the Data editor Show confirmation before save | Displays a prompt asking for a confirmation before saving changes Show errors in a dialog | Presents error messages in a separate dialog box Mark occurrences of the selected cell's value | Highlights instances of the selected cell's value within the data set Show images in web browser | Controls whether image data (e.g., PNG, JPEG stored as BLOBs) is displayed in the Value panel using an embedded browser. When disabled, images are shown as raw binary or hex. ## Appearance¶ Customize how data looks in different modes. Setting | Description ---|--- Switch to **Record** /**Grid** mode on single/multiple row(s) | Allow to switch between **Record mode** and **Grid mode** when dealing with single or multiple rows. When set to true, the system will automatically switch modes based on the number of rows selected (**Record mode** for a single row, **Grid mode** for multiple rows) Show filters panel in single tab mode | Shows the filters panel when using a single-tab layout in the Data Editor Show column description in header | Displays the description for each column in the header Calculate column width by cell values | Adjusts the width of each column based on the content of its cells Show connection name in status | Displays the name of the connection in the status section Visualize complex columns | Enables the visualization of complex columns (such as `objects`, `structures` and `arrays`) Right-justify numbers | Allows right-justify numbers Right-justify date/time values | Aligns date and time values to the right side of their respective cells or columns Enable auto-completion in data filter text | Activates the auto-completion feature in the data filter text field ### Grid¶ Configure **Grid** view options. #### Grid appearance¶ Setting | Description ---|--- Mark odd/even rows | Marks odd and even rows in the grid Colorize data types | Colorizes data types in the grid Show column type icons | Displays icons representing the data types of each column Show attribute filters | Enables the display of attribute filters in the grid Show attribute ordering | Shows asc/desc order icon in column header Show booleans as checkboxes | Represents boolean values in the grid as checkboxes Show whitespace characters | Displays whitespace characters within the grid Show column ordering | Shows column order in the column headers Value display format | Controls how values are shown in the Value panel: \- `Display (default)` shows formatted read-only values, \- `Editable` shows raw editable content \- `Database native` shows the exact value as stored in the database. Max auto size column % | Determines the maximum percentage of width a column can occupy #### Grid behavior¶ Setting | Description ---|--- Highlight rows with selected cells | Enables the highlighting of entire rows when one or more cells are selected Smooth scrolling | Enables smooth horizontal scrolling within the grid Toggle boolean on click | Allows boolean values to be toggled with a single click Select next cell after inline edit | After completing the inline edit, a cell on the next row will be selected, `SHIFT+ENTER` can be pressed to select the cell on the next column Double-click behavior | Defines the action taken when a cell is double-clicked (`None`, `Editor`, `Inline editor`, `Copy selected cell`, `Paste cell value into editor`) Row color batch size | Number of consequent rows with the same background color ### JSON¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Collapse large `JSON` objects or `arrays` to simplify viewing. Setting | Description ---|--- Collapse objects that have more members than | Specifies the max amount of object members before collapsing Collapse arrays that have more elements than | Determines the max amount of array element before collapsing Collapse objects that have deeper nesting than | Determines the max nesting of an object before collapsing Info Read more on [working with JSON](../Working-with-XML-and-JSON/). ### Plain text¶ Adjust text data formatting. Setting | Description ---|--- Tab size | Determines tab size Maximum column length | Determines the maximum length of a column’s content Value display format | Controls how values are shown in the Value panel: \- `Display (default)` shows formatted read-only values, \- `Editable` shows raw editable content \- `Database native` shows the exact value as stored in the database. Show NULLs | Enables the display of `NULL`s Show line numbers | Enables the display of line numbers Leading delimiter | Enables trailing delimiter Trailing delimiter | Enables trailing delimiter Top delimiter | Enables top delimiter Bottom delimiter | Enables bottom delimiter Extra spaces | Enables extra spaces ## Binary editor¶ Configure how binary and LOB data is handled. Setting | Description ---|--- Open in separate editor | Opens separate string editor instead of dialog Binary data formatter | Determines the format in which binary data is displayed Binary editor | Enables to change the binary Data Editor (`EDITOR` or `PANEL`) Maximum length of binary strings | Determines the maximum length of binary strings Maximum LOB length to keep in memory | Determines the maximum length of `LOB` (Large Object) data that will be kept in memory String encoding | Allows to specify the character encoding used when interpreting binary data as strings Cache CLOB values | Enables caching of `CLOB` (Character Large Object) values to reduce repeated reads Cache BLOB values | Enables caching of `BLOB` (Binary Large Object) values for better performance LOB cache max size | Sets the maximum total size of cached `LOB` data Edit LONG columns as LOBs | Treats LONG column types (e.g. in Oracle) as `LOB`s for consistent editing Maximum text editor content length (`KB`) | Limits the size of LOB content (in `KB`) shown in the text editor Commit session on value edit apply | Automatically commits the transaction after applying edited scalar values Commit session on content edit apply | Automatically commits the transaction after editing and saving `LOB` or large content fields ## Data formats¶ Change how numbers, dates, and times are formatted in the Data Editor. Info For details, see [Managing data formats](../Managing-Data-Formats/). ## Dictionaries¶ Define how DBeaver recognizes description columns. Setting | Description ---|--- Keywords for dictionary description columns | Defines which column names are considered descriptive or label columns Maximum amount of elements on a dictionary panel page | Determines how many dictionary values are shown per page ## GIS viewer¶ Adjust spatial data viewer settings. Setting | Description ---|--- Default SRID | Sets the default spatial reference system (e.g. `4326`) Maximum objects per viewer | Limits how many spatial objects are shown at once Minimum zoom level | Prevents zooming too far out on spatial visualizations Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-Editor/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * Data Editor [ Data Editor ](./) Table of contents * Top toolbar * Left sidebar * Right sidebar * Bottom toolbar * Table status indicators * Column context menu * Cell context menu * Additional features * Disable metadata queries * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Top toolbar * Left sidebar * Right sidebar * Bottom toolbar * Table status indicators * Column context menu * Cell context menu * Additional features * Disable metadata queries 1. [DBeaver](/docs/dbeaver) 2. Data Editor # Data Editor The Data editor appears: * as the **Data** tab of the [Database Object Editor](../Database-Object-Editor/), which is only available for tables and views; * as the **Results** tab when you run a custom SQL query in [SQL Editor](../SQL-Editor/). The Data editor allows to view and edit data of a database table or view. The central part of the Data editor is the data grid. The editor also provides top toolbar, bottom toolbar, left sidebar, right sidebar and a filter field: Info To configure how data is displayed and edited, see [Data Editor preferences](../Data-Editor-preferences/). ![](../images/ug/Data-Editor-with-markup.png) Tip To learn about ways to navigate data in the table data, see [Navigation](../Navigation/) article. ## Top toolbar¶ The top toolbar contains the following buttons: Button | Name | Description ---|---|--- ![](../images/filters/data_filters/Remove-all-filters-orderings.png) | **Remove all filters/orderings** | Removes all filters and orderings applied to the data in the filter field. ![](../images/ug/Filter-button.png) | **Custom Filters** | Opens the Result Set Order/Filter Settings window. See [Data Filters](../Data-Filters/) article for more information. ![](../images/filters/data_filters/Save-filter-settings-for-current-object.png) | **Save filter settings** | See [Save filter settings](../Data-Filters/#save-filter-settings) for more details. ![](../images/ug/History-navigation.png) | Forward and backward - history navigation buttons | Navigate forward and backward in the Data Editor history, see the [history section](../Navigation/#history) of our article for more information. ## Left sidebar¶ The left sidebar contains the following tabs: Button | Name | Description ---|---|--- ![](../images/ug/Grid-button.png) | **Grid** | Switches to the grid view of data. ![](../images/ug/Text-button.png) | **Text** | Switches to the plain text view of data. ![](../images/ug/spatial-button.png) | **Spatial** | Switches to the spatial view. For more details, see the [GIS data](../Working-with-Spatial-GIS-data/) article. ![](../images/ug/Chart_button.png) | **Chart** | Switches to the chart view. For more details, see [Charts](../Managing-Charts/). ![](../images/ug/Record-button.png) | **Record** | \- Same as pressing `Tab` \- Switches the positions of rows and columns so that the columns appear as rows, and the rows hide in one **Value** column. See details in the [Table vs. Record Views section](../Data-View-and-Format/#table-and-record-views) of our article. ## Right sidebar¶ The right sidebar contains the following tabs (see the [Panels](../Panels/) for more information): Button | Name | Description ---|---|--- ![](../images/ug/panels-button.png) | **Panels** | Opens panels on the right side of the Data Editor. ![](../images/ug/Calc-button.png) | **Calc** | Opens the result cells calculation panel (`SUM`, `MAX`, `AVG`, etc.). ![](../images/ug/Grouping-button.png) | **Grouping** | Opens grouping panel window tools. ![](../images/ug/Metadata-button.png) | **Metadata** | Opens Metadata panel. ![](../images/ug/References-button.png) | **References** | Opens References panel. ![](../images/ug/Value-button.png) | **Value** | Opens Value Viewer. ![](../images/ug/Result-details-button.png) | **Result Details** /**Query Trace** | Opens the Result Details or Query Trace panel depending on the database. Note The **Result Details** panel is compatible with specific databases such as [BigQuery](../Database-driver-BigQuery/), while the **Query Trace** panel is available for [Cassandra](../Cassandra/) and Yugabyte CQL. For guidance on enabling **Query Trace** , see [Query Trace Panel article](../Query-Trace- Panel/). ## Bottom toolbar¶ The bottom toolbar provides the following buttons: Button | Name | Description ---|---|--- ![](../images/ug/Refresh-button.png) | **Refresh** | Refreshes the whole results set, including all items that are not visible on the screen, while its dropdown option allows to customize the refresh frequency over a specific period. ![](../images/ug/Save-button-Data-Editor.png) | **Save** | Saves all unsaved changes to the data such as adding, duplicating, deleting rows, inline editing of values. See [the Data Viewing and Editing](../Data-Viewing-and-Editing/) article for information. ![](../images/ug/Cancel-button-Data-Editor.png) | **Cancel** | Discards all unsaved changes to the data. ![](../images/ug/Edit-cell-value-button.png) | **Edit cell value in separate dialog/editor** | Opens the cell in focus for editing in a separate editor or dialog box. See details in the [Cell Editor section](../Data-Viewing-and-Editing/#cell-editor) of our article. ![](../images/ug/Add-new-row-button.png) | **Add new row** | Adds a new empty row below the current row, see details in the [Adding, Copying and Deleting Rows section](../Data-Viewing-and-Editing/#rows-manipulation) of our article. ![](../images/ug/Duplicate-current-row-button.png) | **Duplicate current row** | Copies the current rows and pastes the copy below the current row, see details in [Adding, Copying and Deleting Rows section](../Data-Viewing-and-Editing/#rows-manipulation) of our article. ![](../images/ug/Delete-current-row-button.png) | **Delete current row** | Colors the rows in focus in red to mark them for deletion, see details in the [Adding, Copying and Deleting Rows section](../Data-Viewing-and-Editing/#rows-manipulation) of our article. ![](../images/ug/Move-to-first-row-button.png) | **Move to first row** | Moves the focus (highlighting) from the current to the first row of the table. ![](../images/ug/Move-to-previous-row-button.png) | **Move to previous row** | Moves the focus (highlighting) from the current to the previous row of the table. ![](../images/ug/Move-to-next-row-button.png) | **Move to next row** | Moves the focus (highlighting) from the current to the next row of the table. ![](../images/ug/Move-to-last-row-button.png) | **Move to last row** | Moves the focus (highlighting) from the current to the last row of the table. ![](../images/ug/Fetch-all-rows-button.png) | **Fetch all data** | Fetches the whole result set making it ready for display. See the [Scrolling Results Page section](../Navigation/#scrolling-results-page) of our article. ![](../images/ug/Configure-columns-visibility-icon.png) | **Configure** | Opens a menu with settings. ![](../images/ug/fetch-size-window.png) | **Result-set fetch size** | Displays the initial fetch number of rows in the result set on loading or refreshing. ![](../images/ug/Calculate-total-rows-button.png) | **Calculate total row count** | Calculates the total number of rows in the table. To learn how many rows the table data contains, click the **Calculate total row count** button. The number of rows appears in a status field next to the button: ![](../images/ug/Calculate-rows-button.png) Note Some of these buttons may be disabled and may not work if you are using a read-only connection, connecting to a read-only database or if you see the result of a complex query, such as joining two or more tables. ## Table status indicators¶ When working in the Data Editor grid, you might notice icons in the top left corner of each table. These icons are tools to help you quickly understand why you may encounter limitations while attempting to edit data in specific tables. Here is a guide to understanding what each icon means and how it can help you: Icon | Indicator | Description ---|---|--- ![](../images/ug/no-unique-key-found.png) | No unique key was found. Data modification is not possible. | The table lacks a unique key, restricting editing. ![](../images/ug/unique-key-found.png) | PRIMARY KEY `column_name` | A unique key enables editing of the table. ![](../images/ug/virtual-unique-key-found.png) | VIRTUAL PRIMARY KEY `column_name`. | A virtual key enables editing of the table. For more information about virtual keys, see [Virtual keys](../Virtual-Keys/). ![](../images/ug/table-metadata-not-found.png) | Table metadata not found. Data edit is not possible. | Unavailable metadata prevents editing of the table. ![](../images/ug/read-only-connection.png) | Read-only connection. | A read-only connection prevents any edits. Tip In addition to table status indicators, you can highlight column headers. See [Hints](../Data-View-and-Format/#hints) for details. ## Column context menu¶ Each column has a context menu, accessed by clicking the downward arrow button ![](../images/ug/downward-arrow.png), providing different filter options. ![](../images/ug/column-submenu.png) ## Cell context menu¶ Every cell in the table data also has a context menu – right-click the cell to open the menu. The context menu provides the following items: Menu Item | Description ---|--- **Copy** | Copies the content of the current cell or column to the clipboard. **Advanced Copy** | Opens advanced copy submenu that allows copying data with preset formatting parameters. **Paste** | Pastes the copied content to the cells in focus. **Advanced Paste** | Pastes several values delimited with a tabulation or line break starting from the selected cell. **Delete** | Deletes the row that has the cell in focus. **NOTE** : In fact, when users click **Delete** , the system only highlights the red row while the actual deletion happens when users click **Save**. **Edit** | Opens a submenu enabling inline editing. See the [Data Viewing and Editing](../Data-Viewing-and-Editing/) article. **Order** | Displays a submenu that allows to specify ordering criteria for the data. The submenu contains the most common ordering options that can be applied to the column in focus. See details in [Data Filters](../Data-Filters/) article. By default, DBeaver orders data by sending a request to the server (the Server-side results ordering checkbox selected). To order data on the client side using DBeaver's internal algorithm, clear the checkbox. **Filter** | Displays a submenu that allows to specify filter criteria for the data. The submenu contains the most common filters that can be applied to the cell in focus. See details in [Data Filters](../Data-Filters/) article. By default, DBeaver filters data by sending a request to the server (the Server-side results ordering checkbox selected). To filter data on the client side using DBeaver's internal algorithm, clear the checkbox. **View/Format** | Opens a submenu that provides options for formatting and modifying the view of data. See the [Data View and Format](../Data-View-and-Format/) article. **Navigate** | Opens a submenu that helps users to navigate through the table data. See the [Navigation](../Navigation/) article. **Layout** | Changes the layout of data, see the [Data View and Format](../Data-View-and-Format/#table-and-record-views) article. **Export data** | Opens the Data Transfer wizard that guides you through the steps to export data to a selected format. See the [Data Transfer](../Data-transfer/) article. **Note** : The system exports the whole result set including records that are not visible on the screen and preserves all applied data filters and ordering. **Generate SQL** | Opens a submenu where you can select the type of SQL query to generate. See the [SQL Generation](../SQL-Generation/) article. **Generate Mock Data** | Opens Mock Data Generator. See the [Mock Data Generation in DBeaver](../Mock-Data-Generation-in-DBeaver/) article. **Logical structure** | Opens a submenu allowing you to write virtual column expressions, including use of functions, namespaces, and special variables like `row` and `table`. See the article about [Virtual column expressions](../Virtual-column-expressions/). **Open with** | Opens the data in external applications like Excel or a web browser. **Toggle result panel** | Opens Value panel on the right side of the Data Editor. **Refresh** | Refreshes the whole results set including all items that are not visible on the screen. ## Additional features¶ ### Disable metadata queries¶ If you want to improve performance and save money in databases where you pay for each query, you can stop reading the metadata queries in the Data Editor. This means the editor would not automatically ask for information about tables and columns. To enable, navigate to **Window - > Preferences -> Connections -> Metadata** and check the option **Do not read tables information in SQL and data editors**. * **Benefits** : * Makes the Editor work faster because it runs fewer queries. * Saves money in databases where each query costs you, by only running queries that you start yourself. * **Disadvantages** : * You won't have auto-completion or other tools that need metadata. * Results from queries are read-only. To check if modifications are possible, look for an indicator in the top left corner of the table grid. For more information on indicators, see Table status indicators. Tip This setting is particularly valuable for managing databases, such as: * [Amazon Athena](../Database-driver-Amazon-Athena/) * [Amazon Redshift Serverless](../Database-driver-Amazon-Redshift/) * [Amazon Timestream](../Database-driver-Amazon-Timestream/) * [AWS DynamoDB](../AWS-DynamoDB/) * [AWS Keyspaces](../AWS-Keyspaces/) * [Databricks](../Database-driver-Databricks/) * [Google BigQuery](../Database-driver-BigQuery/) * [Google Cloud Spanner](../Database-driver-Google-Cloud-Spanner/) * [Snowflake](../Snowflake/) In general, any cloud database may charge for metadata queries, even when you're just browsing schema or table lists. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-Filters/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * Data filters [ Data filters ](./) Table of contents * Filtering and sorting data * Filter using SQL expressions * Filter by cell value * Apply preset SQL filters or templates * Clear filters * Save filter settings * Result set settings * Managing display of columns in data table * Ordering data in columns * Sorting columns in data table * Custom filters * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Filtering and sorting data * Filter using SQL expressions * Filter by cell value * Apply preset SQL filters or templates * Clear filters * Save filter settings * Result set settings * Managing display of columns in data table * Ordering data in columns * Sorting columns in data table * Custom filters 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Data filters DBeaver lets you filter data in the [Data editor](../Data-Editor/) to quickly find what you need. You can filter using SQL expressions, preset filters, specific cell values, or advanced filter settings. ## Filtering and sorting data¶ ### Filter using SQL expressions¶ Filter data directly using custom SQL criteria: 1. Enter an SQL expression in the [filter field](../Data-Editor/#top-toolbar) above the table. 2. Click **Apply filter criteria** (![](../images/filters/data_filters/Apply-filter-criteria-button.png)) or press `Enter`. ![](../images/filters/data_filters/Filter_field.png) To revert or switch between previously used filters: * Delete the SQL expression and press `Enter` to clear the current filter. * Use the arrow buttons (![](../images/filters/data_filters/filter-history-arrows.png)) to navigate back and forward through your filter history. For more details, see [Navigation](../Navigation/#history). ### Filter by cell value¶ Quickly filter data based on specific values in your columns: 1. Do one of these: 2. Click the filter icon in the column header. 3. Right-click a cell. 4. Select **Filter by value** , then choose a specific value and **Apply filter criteria**. ![](../images/filters/data_filters/Filter-via-column-header.png) ### Apply preset SQL filters or templates¶ Use built-in filter expressions or templates to quickly apply common criteria: 1. Do one of these: * Press `Ctrl+F11` (`⌃F11` on macOS), or right-click a cell and select **Order** or **Filter**. * Click the arrow in the column header. 2. Select a filter expression or template from the menu. Menu section | Option | Description ---|---|--- **Order** | Order by [column name] `ASC` | Sort rows by ascending values. | Order by [column name] `DESC` | Sort rows by descending values. **Filter by value** | [column name] = `value` | Show rows equal to the selected value. | [column name] <> `value` | Show rows not equal to the selected value. | [column name] > `value` | Show rows greater than the selected value. | [column name] < `value` | Show rows less than the selected value. **Custom** | [column name] = .. | Specify a custom equality filter. | [column name] <> .. | Specify a custom inequality filter. | [column name] > .. | Specify a custom "greater than" filter. | [column name] < .. | Specify a custom "less than" filter. **Clipboard** | [column name] = `clipboard content` | Filter rows equal to clipboard content. | [column name] <> `clipboard content` | Filter rows not equal to clipboard content. | [column name] > `clipboard content` | Filter rows greater than clipboard content. | [column name] < `clipboard content` | Filter rows less than clipboard content. | [column name] IS `NULL` | Show rows with null values. | [column name] IS `NOT NULL` | Show rows with non-null values. **Other options** | Save filter settings | Save current filter configuration for reuse | Remove all filters/orderings | Clear all active filters and sorting | Customize filters | Define advanced filter criteria or manage saved filters ![](../images/filters/data_filters/Filters-menu.png) ### Clear filters¶ To remove all active filters and sorting at once, click **Remove All Filters/Orderings** (![](../images/filters/data_filters/Remove-all-filters- orderings.png)). ### Save filter settings¶ To save your current filter settings for future use: 1. Click the arrow next to **Customize filters** (![](../images/ug/Filter-button.png)). ![](../images/filters/data_filters/filter-criteria-button-arrow.png) 2. Select **Save filter settings for current object** (![](../images/filters/data_filters/Save-filter-settings-for-current-object.png)). Saved settings reapply automatically when you reopen the table or query results. ## Result set settings¶ The main way to customize your data table’s appearance is with the **Result Set Order/filter Settings** window. ![](../images/filters/data_filters/Result-Set-Settings-window.png) To open this window: * Click the **Custom Filters** button (![](../images/ug/Filter-button.png)) in the editor's top toolbar. * Click the **Show attribute filters** button (![](../images/ug/Filter-button.png)) in the column header, then select **Customize filters** from the dropdown menu. * Right-click on the table and select **Filters - > Customize filters** from the context menu. The **Result Set Order/filter Settings** window provides the following options: Feature | Description ---|--- **Visible** | Set column visibility. For details, see Managing display of columns in data table. **Pinned** | Pin columns in position. **Order** | Sort data within columns. For details, see Ordering data in columns. **Criteria** | Filter using SQL expressions. You can also enter criteria directly in the filter field. For details, see Filter field syntax. Tip You can also adjust the table directly from column headers. For details, see Ordering data in columns. ### Managing display of columns in data table¶ 1. Open the **Result Set Order/filter Settings** window 2. To show or hide specific columns: 3. Select checkboxes for columns you want to show 4. Clear checkboxes for columns you want to hide 5. Click **OK** to apply the changes. ![](../images/filters/data_filters/Unhide-columns.png) You can also quickly manage columns using these toolbar buttons: Button | Action ---|--- ![](../images/filters/data_filters/Show-all-button.png) | Show all columns. ![](../images/filters/data_filters/Show-None-button.png) | Hide all columns. ![](../images/filters/data_filters/Reset-button.png) | Reset to default. ### Ordering data in columns¶ You can order data in columns three ways: 1. **From column headers** : 2. Click the arrow next to **Customize filters** (![](../images/filters/data_filters/filter-criteria-button.png)). 3. Choose ordering options from the dropdown menu. Menu section | Option | Description ---|---|--- **Order** | Order by [column name] `ASC` | Sort rows by ascending values. | Order by [column name] `DESC` | Sort rows by descending values. Note After selecting an ordering option, an arrow appears in the column header. If ascending (`ASC`), clicking the arrow switches it to descending (`DESC`). To remove ordering, click the order icon in the column header. Tip To sort by multiple columns, set sorting column-by-column, starting with the primary column. 4. **From context menu** : Right-click on the column, choose **Order** and select **Order by [column name]`ASC`** or **Order by [column name]`DESC`**. 5. Sorting columns in data **Result Set Order/filter Settings** window: 1. Open the **Result Set Order/filter Settings** window. ![](../images/filters/data_filters/Sorting-ordering-columns.png) The **Order** column shows sorting priority. To set or change sorting: 2. Click the cell in the **Order** column next to the column name: * **One click** : ascending order (↑). * **Two clicks** : descending order (↓). * **Three clicks** : removes sorting. 3. Click **OK** to apply the changes. You can also quickly manage sorting order using these toolbar buttons: Button | Action ---|--- ![](../images/filters/data_filters/Move-up-down-buttons.png) | Move columns up or down ![](../images/filters/data_filters/Reset-button.png) | Reset to default ### Sorting columns in data table¶ You can rearrange columns two ways: * Drag the column type icon in the header to a new position. * Open the **Result Set Order/filter Settings** window, then: * Click **Sort** (![](../images/filters/data_filters/Sort-button.png)) to sort columns alphabetically. * Click the column name, then use buttons (![](../images/filters/data_filters/Move-up-down-buttons.png)) to move the column up or down and click **OK**. ### Custom filters¶ Use **Custom filters** to manually set `WHERE` and `ORDER BY` conditions. To use custom filters: 1. Open the **Result Set Order/filter Settings** window. 2. Go to the **Custom** tab. 3. In the **Where** box, enter a custom SQL condition. * Example: `InvoiceId = 1` 4. In the **Order by** box, define how to sort the rows. * Example: `UnitPrice DESC` 5. Click **OK** to apply the changes. Tip You don’t need to write the full SQL statement - just the conditions. `WHERE` and `ORDER BY` keywords are already implied. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-Refresh/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * Data refresh [ Data refresh ](./) Table of contents * Auto refresh * Use a predetermined duration * Set your duration * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Auto refresh * Use a predetermined duration * Set your duration 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Data refresh In the bottom left part of the Data editor, you can find the toolbar with actions: ![image](https://user- images.githubusercontent.com/20579256/203996035-f967687c-95bb-4ebf- bcc4-11ba6976bb1f.png) Refreshing is necessary if the database contains changes made by other users working on it simultaneously with you, and you want to see them in your DBeaver window. To refresh data manually, right-click anywhere in the data table and click ![image](https://user- images.githubusercontent.com/20579256/203995457-b755081f-18d4-46e8-b998-56a7ebd1eba2.png) on the context menu or press `F5`. ## Auto refresh¶ You can also schedule auto-refresh to happen regularly. To auto-refresh the database on schedule: Click on the arrow in the auto-refresh button ![image](https://user- images.githubusercontent.com/20579256/203995457-b755081f-18d4-46e8-b998-56a7ebd1eba2.png) Now you can configure auto refresh in the two following ways: ### Use a predetermined duration¶ You can select via choosing an available predetermined period in the context menu. Info ![image](https://user- images.githubusercontent.com/20579256/203997905-7662c487-743c-45ef-8704-ad6dc88e1b5a.png) ### Set your duration¶ You can set your time duration between refreshes. To do that, select ![image](https://user- images.githubusercontent.com/20579256/204000833-1c185296-5fde-4425-93ed-c1e26bc1f86f.png).The Auto-refresh configuration dialog box will open: ![image](https://user- images.githubusercontent.com/20579256/203996140-4b3267ea-0d29-45a2-bdf8-0c60208a48a3.png) 1\. Set **Interval** in seconds. 2\. Select the **Stop on error** checkbox if you want the refresh to stop when it encounters an error or clear it if the refresh should ignore mistakes. 3\. Click **OK**. When you perform either of these two alternative options above, the system starts refreshing the data as scheduled, and the Configure auto-refresh button changes to the **Stop auto-refresh** button ![image](https://user- images.githubusercontent.com/20579256/204000522-e140952e-a256-42e5-8e15-ef4b71e5e331.png). To stop the auto-refresh, click the **Stop auto-refresh** button or the arrow next to it and click **Stop** on the auto-refresh menu. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-Search/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * Data search [ Data search ](./) Table of contents * Search * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Search 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Search # Data search ## Search¶ To search for data in the result set, press `CTRL+F`. The standard Find/Replace search dialog box will open: ![](../images/ug/Find-Replace-window.png) You can also use the Find and Replace feature. Note The system searches only in already fetched rows. Setting | Description ---|--- Case sensitive | By default, the search is case insensitive. Whole word | By default, the word specified in the search field can be found in the case when the word is part of another word. Enabling this setting will lead to a particular word search. Regular expressions | Enable to use regular expressions in the search. In the search field, you can use `Ctrl+Space` for autocomplete regular expressions templates. Wrap search | Enable this setting to find matches throughout the object from the beginning, and not only from the focus point to the end of the object. Incremental | Matches are found incrementally as you type, if this setting enabled. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-Transfer-Actions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * Data transfer actions [ Data transfer actions ](./) Table of contents * Available actions * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Available actions 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. AI functions # Data transfer actions ![tag-outline](/docs/includes/icons/tag-outline.svg)Since 25.3 This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. AI data transfer actions help you run export, import, and comparison tools through natural language. When your request describes an action, DBeaver opens the appropriate wizard and picks the right mode or format based on what you asked. ![](../images/ai/ai-functions-data-transfer-example.png) To use the actions: 1. Open [AI chat](../AI-chat/) on the connection you want to work with 2. Write a prompt that describes the export, import, or comparison you need Note To use an action, make sure it’s turned on in the [Functions settings](../AI-Assistance-settings/#functions). 3. AI reads your request and opens the matching wizard with the right mode or format ## Available actions¶ Use these actions when you want to export data to a file, import a file into a table, or move data between tables or databases. Just describe what you want in AI chat, and the assistant opens the wizard that matches your request. Action | What it does | What opens | Example ---|---|---|--- **Compare data** | Checks differences between tables or databases | \- [Data Compare](../Data-compare/) wizard \- Tables or schemas from your request pre-selected \- Mapping adjustable before running the comparison | `"compare stage.Album data with prod.Album"` **Compare schemas** | Compares database structures | \- [Schema Compare](../Schema-compare/) wizard \- Source and target databases filled in \- You can review changes, scripts, and sync options | `"compare stage.Invoice schema with prod.Invoice schema"` **Export query results to a file** | Saves the current query results as a file | \- [Data export](../Data-export/) wizard in export mode \- Format inferred from your request (CSV, XLSX, JSON, etc.) \- Active results tab used as the source | `"export these results as a CSV file"` **Export table data to a file** | Exports one or more tables without writing SQL | \- [Data export](../Data-export/) wizard \- Selected tables pre-filled | `"export stage.Album as CSV"` **Import data** | Imports a file into a selected table | \- [Data import](../Data-import/) wizard in import mode \- Target table pre-selected \- You pick the file \- Column mapping shown after file selection | `"import a CSV file into my table"` **Transfer data between tables** | Copies data from one table to another | \- [Data migration](../Data-migration/) wizard \- Source and target tables set \- Transfer method selected automatically \- Filters and mappings adjustable before starting the job | `"migrate data from prod.customers to stage.customers"` Note To use an action, make sure it’s turned on in the [Functions settings](../AI-Assistance-settings/#functions). If the matching action is enabled, the assistant opens the correct wizard automatically. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-View-and-Format/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * Data view and format [ Data view and format ](./) Table of contents * Data presentation * Table and Record views * Hints * Formatting data * Value display formats * Data transform * Complex data types * Customizing numeric and date formats * Customizing boolean values * Text based mode * Icon based mode * Row coloring * Coloring rows by value * Coloring rows by data types * Advanced coloring options * Gradient coloring * Regular expression * Reset coloring * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Data presentation * Table and Record views * Hints * Formatting data * Value display formats * Data transform * Complex data types * Customizing numeric and date formats * Customizing boolean values * Text based mode * Icon based mode * Row coloring * Coloring rows by value * Coloring rows by data types * Advanced coloring options * Gradient coloring * Regular expression * Reset coloring 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Data view and format In DBeaver you can customize how your data is displayed to suit your needs. ## Data presentation¶ You can switch between data presentations based on your needs. **Button** | **View** | **Description** ---|---|--- ![Grid button](../images/ug/Grid-button.png) | **Grid** | Displays data in a grid, similar to Excel. ![Text button](../images/ug/Text-button.png) | **Text** | Shows data in plain text format. ![XML button](../images/ug/xml-button.png) | **XML** ![](../images/commercial.png) | Shows XML data (for XML tables only). Tip Use `CTRL+~` to toggle between views. ### Table and Record views¶ By default, data appears in the **Table view** , where rows and columns are organized like a spreadsheet. ![](../images/ug/Structurize.png) To switch to **Record view** , which displays columns as rows and hides extra rows in a single **Value** column: * Select a cell and click **Record** ![Record button](../images/ug/Record-button.png) on the bottom toolbar. * Select a cell and press `Tab`. * Or, right-click a cell and select **Layout - > Record**. You can also transform all columns into rows. To do this, select all rows (for example, with `Cmd`+` A`), right-click a cell and select **Layout - > Record**. ![](../images/ug/Record-view.png) Tip You can navigate through rows using the navigation buttons ![Navigation buttons](../images/ug/Navigation-buttons.png) at the bottom or the arrow keys on your keyboard. For more details on navigating through rows, see [Navigation](../Navigation/). ### Hints¶ You can use hints to get additional context for data and understand relationships without opening additional panels. Hints are available for both **cells** and **column headers** : * **Column header hints** display metadata about the entire column, like key constraints or read-only status. * **Cell hints** provide information about individual values, such as foreign key references or array sizes. ![](../images/ug/data-editor-hints.png) To toggle hints: 1. Right-click any cell. 2. Go to **Hints**. 3. Select the specific hints you want to display. Tip You can configure where hints apply - globally, for a specific datasource, or for an individual entity. Use the **Configure for** menu to select the desired level. **Cell hint** | **Displayed information** ---|--- **Foreign keys** ![](../images/commercial.png) | Shows linked table information. **Table references** | Adds a button in the cell to navigate to related table. **Arrays** | Displays the number of elements in the array. **Binary data** | Shows the size of the binary block in bytes. **Timezone** | Indicates the timezone for date or time values. **SRID** | Displays the Spatial Reference System Identifier for geometric or geographic data. **Column hint** | **Displayed information** ---|--- **Keys information** | Displays information about imported and exported keys in column headers. **Column status** | Highlights read-only columns in column headers. For more details on table status indicators, see [Data Editor](../Data-Editor/#table-status-indicators). For foreign key hints, you can customize what is displayed. Right-click a cell with primary key, go to **Hints - > Dictionary title for {column name} referenced row ...**, where you can: * Select specific columns to show in the hint. * Set a custom expression for descriptions. * Define a delimiter to separate values. Note Hints perform additional queries to display detailed information. For databases where minimizing resource usage is important, you can disable metadata reading. For more details, see [Disabling metadata queries](../Data- Editor/#disable-metadata-queries). ## Formatting data¶ You can transform how data is presented in DBeaver. ### Value display formats¶ **Format** | **Description** ---|--- **Display (default)** | Shows data with standard formatting applied for clarity. **Editable** | Displays data in a plain, editable text format, useful for quick changes. **Database native** | Presents data as it appears in the database without additional formatting, reflecting the raw values. To switch between these formats: 1. Right-click a cell. 2. Go to **View/Formats - > Value display format**. 3. Select format. ### Data transform¶ 1. Right-click a cell and choose **View/Format - > Set {column name} transform**. 2. Select a format (e.g., URL, Binary, Numeric, Geometry) and click **OK**. 3. The settings window opens where you can adjust additional options based on the data type: **Format** | **Description** | **Settings** ---|---|--- **URL** | Displays the value as a clickable URL. | \- **URL pattern** : Set a URL template using `${value}` as a placeholder. **Numeric** | Converts a string value into a numeric type. | \- **Type** : Choose a numeric type. | | \- **Lenient** : Ignore conversion errors and display the original value instead of showing an error. **Binary** | Displays the value as binary data. | \- **Binary format** : Choose a format. | | \- **Character encoding** : Set encoding. **Geometry** | Shows data as spatial geometry. | \- **SRID** : Set the spatial reference system ID. | | \- **Invert coordinates** : Switch the order of coordinates. | | \- **MySQL-compatible format** : Enable compatibility with MySQL geometry. 4. To reset the format to default, right-click any cell and select **View/Format - > Set {column name} transform -> Default**. Tip To format multiple columns at once, open the **Transforms** window: 1\. Right- click any cell and select **View/Format - > Columns transforms...**. 2\. In the window that opens, adjust the formatting settings for multiple columns at the same time. ### Complex data types¶ For structured data (like objects, structures or arrays), you can expand them into columns. * Right-click a cell and choose **View/Format - > Show complex columns structure**. ![](../images/ug/Structurize.png) ### Customizing numeric and date formats¶ You can specify how numeric and time-based data is formatted globally or for a specific database: 1. Right-click a cell, then select **View/Format - > Data formats**. 2. In the Properties window, adjust settings: * To apply changes to the current database, check **Datasource "[Connection name]" settings**. * To apply globally, choose **Global settings**. Info For more details, see [Managing data formats](../Managing-Data-Formats/). ### Customizing boolean values¶ You can choose between text-based or icon-based presentations for boolean values. Go to **Window - > Preferences -> User Interface -> Miscellaneous**. To toggle between **text-based** and **icon-based** modes, select the desired **Display mode**. #### Text based mode¶ You can customize the following options: 1. Update labels under the **Label** column or use presets. 2. Align text to the left, center, or right. 3. Change colors using the **Color** column or reset to the theme’s default. 4. Adjust the font style (normal, **bold** , or _italic_). ![](../images/ug/Data-boolean-presentation-preferences.png) #### Icon based mode¶ In this mode, you can only adjust alignment. ## Row coloring¶ ### Coloring rows by value¶ You can highlight rows with the same value in a specific column: 1. Right-click a cell, then select **View/Format - > Set row color for {column name = value}**. 2. Choose a color in the palette window and exit the window. ![](../images/ug/Colored_rows.png) ### Coloring rows by data types¶ You can color values based on their data type. 1. To enable or disable data tyoe colorizing, right-click any cell, select **View/Format** , and check or uncheck **Colorize Data Types**. 2. To customize colors for each data type, go to **Window - > Preferences -> User Interface -> Appearance -> Colors and Fonts**. Note Primary key and foreign key columns aren’t colorized. ### Advanced coloring options¶ For advanced options, choose **View/Format - > Row colors...**. In this window you can set multiple conditions, define ranges, or even use regular expressions. ![](../images/ug/Row-coloring-customization.png) Section | Description ---|--- **Fields list (left panel)** | A large list that shows all the available fields (e.g., `id`, `city`, `name`, etc.) that you can customize. **Configuration panel (right panel)** | The area where you configure settings for the selected field. It contains: **Settings (top-right field)** | Displays current rules or conditions applied to the selected column. Use the buttons on the right to: | \- **Add** a new condition ![Add Row Button](../images/ug/Add-new-row- button.png). | \- **Delete** an existing condition ![Delete Row Button](../images/ug/Delete-connection-type-button.png). **Range/gradient** | Enables gradient coloring for a value range. **Apply colors to this column only** | Restricts the color rule to the selected column. **Operator** | Defines the comparison operator for conditions. Options include: `=`, `<>`, `>`, `>=`, `<`, `<=`, `ILIKE`, `LIKE`, `NOT LIKE`, and `REGEX`. **Value(s)** | Sets the value or range for the condition. To define a range, enable the **Range/Gradient** checkbox and specify the minimum and maximum values (e.g., `1` to `10`). **Background** | Allows you to choose colors for the cell/s background. **Foreground** | Sets the text color inside the cells. #### Gradient coloring¶ You can use gradients to highlight data within a range. For example, you can highlight `Id` values from `1` to `10` with a gradient transitioning. 1. Right-click on the cell and go to **View/Format - > Row colors...**. 2. Select the column containing `Id`. 3. In the **Values** section, set the range (e.g., from `1` to `10`). 4. Choose a **Background** color for the start and end of the range. 5. Use **Foreground** to set the text color inside the cells, if needed. 6. Press **OK** to save your settings. #### Regular expression¶ You can use regular expressions to highlight specific rows. 1. Right-click on the cell and go to **View/Format - > Row colors...**. 2. Set the **Operator** to **REGEX**. 3. In the **Value** field, enter the desired regular expression. 4. Choose a **Background** color. 5. Use **Foreground** to set the text color inside the cells, if needed. 6. Press **OK** to save your settings. ### Reset coloring¶ If you want to remove a specific highlight: * Right-click the cell again and select **View/Format - > Clear color for {column name = value}**. * Or right-click the cell again and select **View/Format - > Reset all row coloring**. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-Viewing-and-Editing/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * Data viewing and editing [ Data viewing and editing ](./) Table of contents * Inline editing * Cell Editor * Data format handling * Specialized handling of CLOB and BLOB data types * Setting cell value to NULL * Setting cell value to default * Rows manipulation * Copying and pasting cells * Basic copy * Advanced copy * Basic paste * Advanced paste * Saving and previewing changes * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Inline editing * Cell Editor * Data format handling * Specialized handling of CLOB and BLOB data types * Setting cell value to NULL * Setting cell value to default * Rows manipulation * Copying and pasting cells * Basic copy * Advanced copy * Basic paste * Advanced paste * Saving and previewing changes 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Data viewing and editing DBeaver provides tools for data editing and viewing within its [Data Editor](../Data-Editor/). It supports inline editing in the grid view for quick data changes and a cell editor for more intricate entries, including a multi-line text. Users can manage rows by adding, copying, or deleting them and can utilize copy-paste functions for data transfer. Detailed information on these features and the steps for saving and reviewing changes are provided in the following sections. ## Inline editing¶ Inline editing refers to the process of modifying content directly within a cell in a table. To initiate inline editing, users have several options: * Double-click the desired cell. * Click the cell to focus on it, then press `Enter`. * Right-click the cell and select **Inline edit** from the context menu. Once in inline editing mode, the cell becomes editable, allowing the user to modify its value. Tip If your table doesn't have unique keys, DBeaver lets you create [virtual keys](../Virtual-Keys/) to edit data. ## Cell Editor¶ The Cell Editor in DBeaver is a tool designed for detailed data editing within individual cells. To access the Cell Editor, follow either of these methods: * Right-click on the desired cell and select **Edit - > Edit cell** from the context menu. * Click the cell to focus, then either press `Shift+Enter` or click the **Edit cell** button (![](../images/ug/Edit-cell-value-button.png)) located in the bottom toolbar. Note The toolbar is customizable. See [Toolbar Customization](../Toolbar- Customization/) article. ### Data format handling¶ DBeaver manages a variety of data formats, and for most cells, activating the Cell Editor displays a property window: ![](../images/ug/Edit-cell-window.png) This window is divided into two main sections: * **Column Info** : Provides detailed properties of the column. * **Value** : Enables users to modify the cell's value. After making changes, click **Save** to apply them. For extended editing, use the **Open Editor** option for a separate editor tab. ### Specialized handling of CLOB and BLOB data types¶ In addition to general data formats, DBeaver offers specialized support for `CLOB`/`BLOB` data types: * **Editing CLOB/BLOB data** : Editing cells containing `CLOB`/`BLOB` data in the Cell Editor opens the content in a new tab, allowing for comprehensive editing, particularly useful for large data objects. * **Saving/Loading BLOB values** : Users can save and load `BLOB` values to and from external files, aiding in the management of binary data like images and large text files. * **Image display in BLOB Columns** : DBeaver automatically renders images stored in `BLOB` columns (formats like `gif`, `png`, `jpeg`, `bmp`) within the interface, streamlining the process of viewing image data. * **Value View panel** : To efficiently browse images in `BLOB` columns, users can activate the value view panel by pressing `F7`. ### Setting cell value to NULL¶ To set a cell's value to `NULL`, right-click on the cell and choose **Edit - > Edit cell -> Set to NULL**. ### Setting cell value to default¶ To set a cell's value to its default, right-click on the cell and select **Edit - > Set to default** from the context menu. The default value for the field, if predefined, will be displayed in parentheses next to this option. ## Rows manipulation¶ Refer to the table below for instructions on adding, copying, and deleting rows in DBeaver's Data Editor. Action | Description | Button/Image ---|---|--- **Adding rows** | To add a new, empty row, click the **Add row** button in the bottom toolbar. This inserts a row below the focused row. Populate the new row via inline editing or separate cell editor. | ![Add Row Button](../images/ug/Add-new-row-button.png) **Copying rows** | To duplicate rows, select the rows and click the **Duplicate row** button. The duplicates will appear below the original rows. | ![Duplicate Row Button](../images/ug/Duplicate-current-row-button.png) **Deleting rows** | For deleting rows, select them and click the **Delete current row** button. Rows marked for deletion turn red and are removed upon saving. | ![Delete Row Button](../images/ug/Delete-current-row-button.png) ## Copying and pasting cells¶ This section outlines the procedures for copying and pasting cell data within DBeaver. ### Basic copy¶ To copy the contents of one or more cells to the clipboard in a TAB-delimited format, you can use the shortcut ` Ctrl+C`. Alternatively, right-click on the cell or selection of cells and select **Copy** from the context menu. This copied content can then be pasted into spreadsheet editors like Excel. ### Advanced copy¶ For more control over the copy process, DBeaver offers an advanced copy option. This feature allows users to include column names and row numbers, configure delimiters, and choose value formats during the copy operation. Activate this feature by pressing `Ctrl+Shift+C` or by selecting **Advanced Copy - > Advanced Copy** from the context menu after right-clicking on the selected cells. The Advanced Copy settings window provides various options: Field | Description ---|--- **Copy header** | Includes the column names as headers in the copied data. **Copy row numbers** | Adds the row number for each row in the copied data. **Quote cell values** | Encloses each cell value in quotes. **Always quote values** | Forces quoting of all cell values, regardless of the need. **Copy as HTML** | Formats the copied data as HTML, suitable for web publishing. **Value display format** | Determines how the copied data will be displayed. **Column Delimiter** | Character or sequence used to separate columns in the copied data. **Row Delimiter** | Character or sequence used to separate rows in the copied data. **Quote Character** | Character used to quote cell values if quoting is enabled. In addition to these options, users can perform a **Save as** operation in various formats by selecting **Advanced Copy** from the context menu after right-clicking on the selected cells, which can be further configured for each format. Here are the additional options available: Option | Description ---|--- **Copy as CSV** | Copies the data in Comma-Separated Values format. **Copy as DbUnit** | Copies the data in the DbUnit dataset format. **Copy as HTML** | Copies the data in Hypertext Markup Language format for web use. **Copy as JSON** | Copies the data in JavaScript Object Notation format. **Copy as Markdown** | Copies the data in Markdown format suitable for documentation. **Copy as SQL** | Copies the data as SQL INSERT or UPDATE commands. **Copy as Source code** | Copies the data in a format ready to use in source code. **Copy as TXT** | Copies the data as plain text. **Copy as XML** | Copies the data in eXtensible Markup Language format. To further refine how each format is copied, select **Configure 'Copy as' commands...** from the context menu. This opens a configuration window where you can set the specific copying behavior for each format, such as delimiter choice, quoting options, and more, ensuring the copied data meets the requirements of different use cases and target applications. Tip Admin can disable the ability to copy data using the registry or configuration file. For details, see [Admin preference restrictions](../Admin-Preference- Restrictions/#registry-and-configuration-file-parameters). ### Basic paste¶ To paste copied content, press `Ctrl+V` when focusing on a cell. DBeaver intelligently handles the pasting process, applying necessary data type conversions to fit the destination cell's format. ### Advanced paste¶ DBeaver's **Advanced Paste** feature caters to scenarios requiring the insertion of multiple cells or complex data structures. It can be accessed through the context menu or by using the shortcut `Ctrl+Shift+V`. When activated, the following options are presented in a dialog: Feature | Description ---|--- **Insert multiple rows** | Allows for the pasting of data into multiple rows at once. **Ignore quotes** | Disregards quotation marks when parsing pasted values. **Insert NULLs** | Allows for pasting the `NULL` values. **NULL value mark** | Defines the symbol or text that represents a `NULL` value. These settings provide additional control over how data is pasted, ensuring that data is inserted correctly and efficiently, especially in bulk operations or when special data considerations are necessary. ## Saving and previewing changes¶ In DBeaver, data modifications are committed to the database when saved. To confirm changes: * Click the **Save** button ![](../images/ug/Save-button-Data-Editor.png) in the bottom toolbar. * To revert modifications, click the **Cancel** button ![](../images/ug/Cancel-button-Data-Editor.png). Tip The **Save** and **Cancel** buttons are enabled only after making edits and moving to another cell. To validate changes before saving, preview the SQL script: * Click the dropdown arrow next to the **Save** button ![](../images/ug/Save-button-Data-Editor.png). * Choose **Generate Script**. The Preview Changes window will display the SQL script for review and copying if required. ![](../images/ug/Preview-changes-window.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-compare/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * Data compare [ Data compare ](./) Table of contents * Steps for comparing data * Choose a comparison type * Keys configuration * Composite keys * Column mapping * Compare settings * Execution log * Viewing the results * Additional tools * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Steps for comparing data * Choose a comparison type * Keys configuration * Composite keys * Column mapping * Compare settings * Execution log * Viewing the results * Additional tools 1. [DBeaver](/docs/dbeaver) 2. Data transfer and schema compare # Data compare Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. DBeaver provides functionality to compare two tables or query results, which is useful when you need to identify minor differences in datasets that appear almost identical. This capability is essential for tasks such as: * quickly visualizing and navigating differences * exporting data that differs between sources ## Steps for comparing data¶ First, select the tables you wish to compare from the [Database Navigator](../Database-Navigator/). Tip You can start the compare through AI by sending a short request in AI chat. See [Data transfer actions](../Data-Transfer-Actions/) for supported commands. ![](../images/ug/tools/data-compare/select-tables-from-Database-Navigator.png) ### Choose a comparison type¶ Select what you will compare by choosing the appropriate tab in the **Source** / **Target** windows. * **Tables** : compare two tables ![](../images/ug/tools/data-compare/choose-tables.png) * **Table to Query** : compare a table with the result of an SQL query ![](../images/ug/tools/data-compare/choose-query-and-table.png) * **Queries** : compare the results of two SQL queries When comparing the results of two SQL queries, you have two methods to perform this operation: * **Use Source/Target Query tabs** Select the **Query** tab in both the **Source** and **Target** windows. Enter your SQL queries directly into these fields to set up the comparison. * **Use SQL Editor** Alternatively, write your SQL queries in the [SQL Editor](../SQL-Editor/). Highlight the queries and choose **Execute - > Data Compare from query**. Tip You can compare objects from the same or different databases, or even between different Relational Database Management Systems (RDBMS), such as PostgreSQL and MySQL. ### Keys configuration¶ Select one or more columns that will serve as the **unique key** for the comparison. Choosing the wrong **keys** may result in invalid comparison results. ![](../images/ug/tools/data-compare/keys-configuration.png) Note By default, if the table has a unique key, it will be selected automatically during the initial setup. If the table doesn’t have a primary key, you can manually select one or more columns to define a unique key. #### Composite keys¶ When you select multiple columns, they form a **composite key**. Composite keys uniquely identify rows based on a combination of values across the selected columns. Tip Select columns for composite keys that, together, uniquely identify each row. Avoid columns with duplicate or null values, as they may impact comparison accuracy. ### Column mapping¶ If the objects you are comparing have different ordering, naming, or quantities of columns, you can adjust their mappings or skip columns that are not of interest. You can use the **Auto assign** button to automatically link columns with the same names. ![](../images/ug/tools/data-compare/column-mapping.png) Note This page will only feature columns that are not used as the primary key configured on the previous page. ### Compare settings¶ On the final page of the **Data Compare** wizard, configure settings to tailor the data comparison to your needs: ![](../images/ug/tools/data-compare/compare-settings.png) Setting | Description ---|--- **Open viewer on finish** | Opens the compare viewer for a visual overview of the differences once the comparison is complete. **Export compare results to file** | Exports the SQL script diff to a file. You can choose the output format and specify the output file path. **Apply changes to** | Chooses which table the exported script updates. Pick **Source table** or **Target table** to define where the `diff` is applied. **Output order** | Controls how changes are sorted in the exported result. **Default** keeps the comparison order. **By type** groups inserts, updates, then deletes. **Output format** | Chooses how the results are written to the file. You can export an **SQL script** or an **HTML table**. **Output file** | Sets the path and file name where DBeaver will save the exported diff. **Limit compared rows to** | Limits how many rows must be compared against each other before ending the comparison. **Limit different rows to** | Limits how many rows must be differ between each other before ending the comparison. **Limit fetch size to** | Determines how many rows should be fetched at once, which helps manage memory and performance during comparison. **Show modified rows** | Determines whether modified rows should be included in the diff or not, allowing you to track changes in the data. **Show deleted rows** | Determines whether deleted rows should be included in the diff or not, providing insight into data that has been removed from the database. **Show inserted rows** | Determines whether newly inserted rows should be included in the diff or not, allowing you to see additions to the database. **Store results in memory** | Stores results in memory for further processing. Note that DBeaver might run out of memory when comparing large tables if this option is enabled. When disabled, results will be stored in a temporary database. **Open new connections** | Opens new physical connections for data reading, which can help manage resources and ensure the stability of data comparison operations. **Query rows count** | Queries row count before performing compare. This lets you track the progress of the comparison but may cause performance faults in some cases. **Save task** | Opens the [**Save Task window**](../Task-Management/) to assist in creating a task during the compare process. This window provides options and settings for creating and configuring a task related to the compare operation. Tip You can export file to a remote file system via [Cloud Storage](../Cloud- Storage/) using the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png). ### Execution log¶ Once you have configured all settings and clicked **Proceed** , the Data Compare wizard will perform the comparison operation: * an **Execution Log** window will display the progress and outcome of the comparison process. * simultaneously, a separate window will open showing the comparison results. This window provides a detailed view of differences between the datasets based on the specified settings ![](../images/ug/tools/data-compare/execution-log.png) ## Viewing the results¶ After the comparison process is complete, you can view the results in the viewer. It highlights the differences between the datasets in detail, with each row that shows a discrepancy being clearly marked. ![](../images/ug/tools/data-compare/data-compare-viewer.png) Note A complete visual preview of the results is available only when **Data Compare** is launched through the wizard. If launched as part of a task, the visual editor will not open. Instead, only statistics will be recorded in the [execution log](../Task-Scheduler/#monitoring-task-execution). ### Additional tools¶ The viewer not only displays the differences but also provides tools to manage and interpret these differences effectively. Here's what you can do within the compare viewer: Feature | Button image | Description ---|---|--- **Export changes** | ![](../images/ug/tools/data-compare/export-changes-button.png) | The results of the **Data Compare** can be exported as an SQL script, which includes `DELETE`, `INSERT`, and `UPDATE` statements to make the data in the second table match the first. Alternatively, you can export the results in an `HTML` format as a table for easy viewing and sharing. **Swap tables** | ![](../images/ug/tools/data-compare/swap-tables-button.png) | The **Swap tables** button allows you to switch the positions of the source and target data panels within the viewer. **Show summary** | ![](../images/ug/tools/data-compare/show-summary-button.png) | By clicking the **Show Summary** button, you can access a statistical summary and analysis of the differences found between the datasets. This summary provides a quick overview of the total changes, including the number of modified, deleted, and inserted rows. Tip You can also export the comparison results table through [Export data](../Data-transfer/) button ![](../images/ug/tools/data-compare/export- data-button.png) in the bottom toolbar or [copy](../Data-Viewing-and- Editing/#copying-and-pasting-cells) rows or individual values that differ. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-export/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * Data export [ Data export ](./) Table of contents * Steps to export data * Export parameters * CSV * DBUnit * JSON * Markdown * Source code * SQL * TXT * XML * XLSX * HTML * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Steps to export data * Export parameters * CSV * DBUnit * JSON * Markdown * Source code * SQL * TXT * XML * XLSX * HTML 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Data transfer # Data export DBeaver allows you to export query results or tables. This guide explains the export process using `CSV` as an example. For details on supported formats, see [Data Transfer](../Data-transfer/#supported-formats). Note Each format may have specific configuration settings that can be adjusted to meet your needs. ## Steps to export data¶ 1. Select the table or tables you want to export. In the context menu, choose **Export Data**. ![](../images/dt/dt-export_menu.png) Alternatively, you can also export data from custom SQL query results. To do that, choose **Export data** in the results context menu. Tip You can start the export through AI by sending a short request in AI chat. See [Data transfer actions](../Data-Transfer-Actions/) for supported commands. 2. In the window that appears, choose `CSV` and click **Next**. ![](../images/dt/dt-export-format.png) 3. Set your data extraction options (how the data will be read from the tables). This may affect the extraction's performance. And set the export format option. They are specific to the data format you chose in step 2: ![](../images/dt/dt-options-extract.png) Setting name | Description ---|--- **Maximum threads** | Number of threads used for data extraction. **Extract type** | Defines the method of data extraction (`Single query` or `Multiple queries`). **Segment size** | The size of data segments to be extracted at a time (active while Multiple queries are selected as an **Extract type**). **Open new connection(s)** | Opens a new physical connection for data reading, recommended if you plan to continue working with the database during the export process. **Select row count** | Queries row count before performing export to track progress, but may cause performance issues in some cases. **Fetch size** | Number of rows the driver retrieves in one batch from the database. **Log SELECT queries** | Records all `SELECT` queries in the [Query Manager](../Query-Manager/) (disabled by default). This may slow data transfer and increase the size of the Query Manager database. Tip The **Maximum threads** option is active when exporting data from multiple tables. It is recommended to set the number of threads to match the number of cores in your computer for optimal performance. 4. Configure the format settings. At this stage, you configure the format settings for the output file. These settings determine how the data will be presented and encoded in the exported file. For more details on exporter settings, see Export parameters. ![](../images/dt/dt-format-settings.png) Setting name | Description ---|--- **Formatting** | Selects the formatting settings for the exported data. Reed more in the related [article](../Managing-Data-Formats/) **Binaries** | Specifies how binary data is represented in the export. **Encoding** | Sets the character encoding for the exported file. **Value display format** | Chooses the format for displaying values in the export. **Configure columns** | Allows you to set which columns to export. Configure the columns to export by clicking **Configure**. In the **Action** column, use the down arrow on a row to toggle between **skip** or **export** for that column/table. ![](../images/dt/export-skip-columns.png) Note The options within the Exporter settings section will vary and provide specific controls tailored to the format selected for export. 5. Set options for output files or clipboards. ![](../images/dt/dt-options-output.png) Tip You can export files to a remote file system via [Cloud Storage](../Cloud- Storage/) using the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png). This feature is exclusively available to users of the Ultimate Edition, Team Edition, and CloudBeaver PRO versions. 6. Review what you want to format and which format you will export. You can also save all your settings as a task in this step or change the task variables: ![](../images/dt/dt-export-final.png) 7. Press finish. See extraction progress. You can keep working with your database during the export process as the extraction will be performed in the background. ![](../images/dt/dt_message-success.png) ## Export parameters¶ In this section, you will find specific configuration settings for each supported export format. These settings allow you to customize the export process according to the requirements of the data format you choose. ### CSV¶ Setting name | Description | Available options ---|---|--- Characters escape | Bad characters escaping model (surrounded with quotes or escaped with '\' character). | `quotes`/`escape` Delimiter | Column delimiter. | You can use special characters like `\t`, `\n`, and `\r`. File extension | The default file extension for the exported file. | `csv` Format numbers | Format numeric values using locale settings. | `true`/`false` Header | CSV header settings. | `none`/`top`/`bottom` Header case | You can choose lower or upper case for column names or descriptions in the header. | `as is`/`upper`/`lower` Header format | Defines the formatting of the header. | `label`/`description`/`both` NULL string | String which will be used instead of NULL values. | Quote always | Quote all cell values. Cannot be used with "Quote Never". | `disabled`/`all`/`strings`/`all but numbers`/`all including nulls` Quote character | Character which will be used to quote strings (space means no quote). | Quote never | Do not quote cell values. Cannot be used with "Quote Always". | `true`/`false` Row delimiter | Row delimiter. Default is system-specific line feed delimiter. | `default`/`\n`/`\r`/`\r\n`/`\n\r` ### DBUnit¶ Setting name | Description | Available options ---|---|--- File extension | The default file extension for the exported file. | `xml` Force upper case column names | Convert all column names to upper case. | `true`/`false` Force upper case table name | Convert the table name to upper case. | `true`/`false` Include NULL values in export | Include NULL values in the exported data. | `true`/`false` Replace NULL values with | Specify a string to replace NULL values in the export. | ### JSON¶ Setting name | Description | Available options ---|---|--- File extension | The default file extension for the exported file. | `json` Format dates in ISO 8601 | Convert all date values to ISO 8601 format. | `true`/`false` Print table name | Include the table name in the exported file. | `true`/`false` Export JSON values as | Export values as text or as JSON objects. | `string`/`JSON` ### Markdown¶ Setting name | Description | Available Options ---|---|--- Confluence format | Enable Confluence-specific Markdown formatting. | `true`/`false` File extension | The default file extension for the exported file. | `md` Format numbers | Format numeric values using locale settings. | `true`/`false` NULL string | String to represent NULL values in the export. | Show header separator | Include a separator line below the header. | `true`/`false` ### Source code¶ Setting name | Description | Available options ---|---|--- File extension | The default file extension for the exported file. | `php` Format dates in ISO 8601 | Convert all date values to ISO 8601 format. | `true`/`false` Language | Specifies the PHP version compatibility for the generated code. | `PHP < 5.4`, `PHP 5.4+` Quote character | Character which will be used to quote strings. | `"`, `'` Row delimiter | Row delimiter. Default is system-specific line feed delimiter. | `default`, `\n`, `\r`, `\r\n`, `\n\r` ### SQL¶ Setting name | Description | Available options ---|---|--- Data rows per statement | Specifies the number of data rows in a single insert statement. | `integer` File extension | The default file extension for the exported file. | `sql` Identifier case | Allows selection of lower or upper keyword case for table and column names. | `as is`/`upper`/`lower` Include generated columns | Specifies whether to include auto-generated columns (e.g., auto-increment) in SQL INSERT statements. | `true`/`false` Insert line before rows | Specifies inserting a line feed before values in multi-row inserts. | `true`/`false` Keyword case | Allows selection of lower or upper keyword case. | `upper`/`lower` Native date/time format | Specifies using native date/time format in INSERT statements. | `true`/`false` Omit schema name | Specifies omitting schema/catalog name in INSERT statements. | `true`/`false` On conflict expression | Provides an expression for the end of the statement. This setting is specific to the database. | Target table name | Allows specification of the target table name to generate an INSERT statement. | Upsert keyword | Allows selection of different upsert keywords. | `INSERT`/`INSERT ALL`/`UPDATE OR`/`UPSERT INTO`/`REPLACE INTO`/`ON DUPLICATE KEY UPDATE`/`ON CONFLICT` ### TXT¶ Setting name | Description | Available options ---|---|--- Batch size | Specifies the number of records per batch. | `integer` File extension | Specifies the file type for output. | `txt` In-between delimiter | Adds a custom character between data values. | Max column length | Specifies the maximum length of data in a column; longer values will be cropped. | `integer` Min column length | Specifies the minimum length of data in a column; shorter values will be padded with spaces. | `integer` Print header | Specifies whether to print column names at the top of the file. | `true`/`false` Show header delimiter | Adds hyphen characters either in the first row without a header or between the header and data. | `true`/`false` Show leading delimiter | Adds a pipe character at the start of the row. | `true`/`false` Show NULLs | Controls the display of NULL values in the output. | `true`/`false` Show trailing delimiter | Adds a pipe character at the end of the row. | `true`/`false` ### XML¶ Setting name | Description | Available options ---|---|--- File extension | Specifies the file type for output. | `xml` Include DOCTYPE declaration | Specifies whether to include the DOCTYPE declaration in the XML file export. | `true`/`false` ### XLSX¶ Setting name | Description | Available options ---|---|--- Append strategy | Strategy used when appending data to an existing file. | `create new sheets`/`use existing sheets` Boolean string FALSE | String that replaces FALSE boolean values in the exported file. | `true`/`false` Boolean string TRUE | String that replaces TRUE boolean values in the exported file. | `true`/`false` Border style | Style of cell borders in the exported file. | `NONE`/`THIN`/`THICK` Excel date format | Date and time format used in the Excel file (modifiable in Excel application). | `m/d/yy` / `d-mmm-yy` / `d-mmm` / `mmm-yy` / `h:mm AM/PM` / `h:mm:ss AM/PM` / `h:mm` / `h:mm:ss` / `m/d/yy h:mm` Column group | Column number used for grouping rows on a sheet by column value. | `integer` Export SQL | Specifies whether to export SQL to a second sheet in the Excel file. | `true`/`false` File extension | File extension for the exported document. | `xlsx` Header format | Format of the header in the exported file. | `label`/`description`/`both`/`none` Header row font | Font styling for the first row in the exported file. | `NONE`/`BOLD`/`ITALIC`/`STRIKEOUT`/`UNDERLINE` Max row on sheet | Maximum number of rows allowed on a single sheet, after which data will split into another sheet. | `integer` NULL string | String used instead of displaying NULL values in the exported file. | Row number(s) | Includes the row index as the first column in the exported file. | `true`/`false` Split SQL Text | Splits exported SQL into rows by CR (Carriage Return) in the exported file. | `true`/`false` Trim strings | Removes extra leading and trailing spaces from all string values in the exported file. | `true`/`false` ### HTML¶ Setting name | Description | Available options ---|---|--- File extension | File extension for the exported document. | `html` Images | Extracts images to graphic files. | `true`/`false` Output column headers | Outputs column names as an additional row in the generated table. | `true`/`false` Output table header | Outputs the query or table name as the first row in the generated table. | `true`/`false` Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-import/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * Data import [ Data import ](./) Table of contents * Steps to import data * Import parameters * CSV * XLSX * XML * Patterns for data and time format * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Steps to import data * Import parameters * CSV * XLSX * XML * Patterns for data and time format 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Data transfer # Data import DBeaver enables you to import data into tables. This guide explains the import process using `XLSX` as an example. For details on supported formats, see [Data Transfer](../Data-transfer/#supported-formats). Note Each format may have specific configuration settings that can be adjusted to meet your needs. ## Steps to import data¶ 1. Choose the database table (or tables) you want to import data into. Do this by right-clicking on the table name in the **Database Navigator** section and then clicking on **Import Data**. ![](../images/dt/xlsx/dt-xlsx-import-files.png) Tip You can start the import through AI by sending a short request in AI chat. See [Data transfer actions](../Data-Transfer-Actions/) for supported commands. 2. In the window that appears, choose `XLSX` and click **Next**. ![](../images/dt/xlsx/dt-xlsx-import-source.png) 3. In the following window, choose the file that contains the data you wish to import into the table, select the appropriate settings, then click **Next**. For more details on importer settings, see Import parameters. Tip Use **Save task** to open the [task window](../Task-Management/) and quickly create or configure a data transfer task. ![](../images/dt/xlsx/dt-xlsx-input-files.png) Tip You can import files from a remote file system using the [Cloud Storage](../Cloud-Storage/) by clicking the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png). This feature is exclusively available to users of the Ultimate Edition, Team Edition, and CloudBeaver PRO versions. 4. In the next window, set XLSX-to-table mappings. Info Refer to our [mapping process](../Data-migration/#step-3-tables-mapping) guide for more detailed information. ![](../images/dt/xlsx/dt-xlsx-tables-mapping.png) 5. Select your data load settings in the subsequent window, and then click **Next**. For more information, please refer to our article's section [**Data load settings**](../Data-migration/#step-5-data-load-settings) article. ![](../images/dt/xlsx/dt-xlsx-data-load-settings.png) 6. In the final window, you can review all the settings you selected earlier. If you missed something, you could go **Back** and fix it. When you are ready, finish the import by clicking **Proceed**. ![](../images/dt/xlsx/dt-xlsx-confirm.png) 7. If the `XLSX` file is valid and there are no errors, you will see a notification window with information about the completion of the task. You can keep working with your database during export, as the data loading will be performed in the background. ![](../images/dt/xml/dt-xml-complete.png) ## Import parameters¶ ### CSV¶ Setting name | Description ---|--- **Encoding** | Character encoding of the file (for example, `UTF-8`). **Column delimiter** | Character that separates columns. You can also use special symbols like `\t` (tab), `\n` (newline), or `\r` (carriage return). **Header position** | Defines if the first row is used as column names (`top`) or if the file has no headers. **Quote char** | Character used to wrap values (for example, `"`). **Ignore characters outside quotes** | Any characters outside quotes that should be ignored during parsing. **Escape char** | Character used to escape special characters (for example, `\`). **NULL value mark** | String used as a marker for `NULL`. These values are imported as `NULL`. **Set empty strings to NULL** | If enabled, empty strings are converted to `NULL`. Otherwise, they are kept as empty values. **Date/time format** | Pattern that defines how to read date and time values. Doesn’t change the output format. See _java DateTimeFormatter_ for details. **Trim whitespaces** | Removes spaces before and after values to prevent parsing errors. **Timezone ID** | Timezone for date/time values. By default, the local machine timezone is used. You can set: \- A local offset (e.g., `+3`, `-04:30`) \- A GMT/UTC offset (e.g., `GMT+2`, `UTC+01:00`) \- A region ID (e.g., `UTC`, `ECT`, `PST`). **Sample rows count** | Number of rows to analyze for guessing column length and data types. **Default column length** | Default length for string columns when creating new ones. **Count length in bytes** | Counts column length in bytes instead of characters. Useful for databases that measure string length in bytes. ### XLSX¶ Setting name | Description ---|--- **Header position** | Determines the location of the column names in the Excel table, either at the top or none. This setting specifies whether the column names are located in the first row of the Excel table or if there are no column names present. **Skip empty rows** | If this setting is enabled, any open string values encountered during the data processing will be ignored and not inserted into the corresponding cells in the row. If the setting is disabled, all cells in the row will be filled with a `NULL` value if an empty string is encountered. **Import all sheets** | Specifies that all sheets in the file should be imported during the data import process. **Specific sheet name** | Enables you to choose a particular sheet from the Excel file for importing during the data transfer process. **Date/time format** | Use this setting to specify the date format used in the `XLSX` file. This is used to clarify the date format during the import process and does not affect the output data. You can refer to the section Patterns for data import for details on the format pattern syntax. **Timezone ID** | The local machine timezone is used by default. There are three ways to specify the timezone: 1) Local zone offset: Specify the offset from UTC in the format of either a positive or negative number (e.g., +3, -04:30). 2) Specific zone offset: Specify the offset from GMT or UTC in the format of GMT+/-X or UTC+/-X (e.g., GMT+2, UTC+01:00). 3) Region-based: Specify the timezone using a region-based identifier such as UTC, ECT, PST, etc. **Sample rows count** | Determines the number of rows that will be used as a sample to estimate the length and data types of the imported data. **Minimum column length** | This value is used when creating a new column and, if necessary, specifying its type. It indicates the minimum number of characters or digits expected in the column. This information helps determine the appropriate data type and size for the column during the creation process. ### XML¶ Setting name | Description ---|--- **Column read method** | Defines how to extract values from XML. Options: \- **elements** \- use nested elements inside item elements \- **attributes** \- use attributes of item elements \- **both** \- use both elements and attributes **Item element** | Name of the element treated as a row (item). If empty, any second-level elements are treated as items. ### Patterns for data and time format¶ When specifying the date/time format for data import, ensure that you use the correct format specifiers. A common issue involves confusing format codes, such as using `MM` (for months) when `mm` (for minutes) is intended. Refer to the table below for a list of common format symbols and their meanings. Symbol | Meaning | Presentation | Examples ---|---|---|--- `G` | era | text | AD; Anno Domini; A `u` | year | year | 2004; 04 `y` | year-of-era | year | 2004; 04 `D` | day-of-year | number | 189 `M/L` | month-of-year | number/text | 7; 07; Jul; July; J `d` | day-of-month | number | 10 `Q/q` | quarter-of-year | number/text | 3; 03; Q3; 3rd quarter `Y` | week-based-year | year | 1996; 96 `w` | week-of-week-based-year | number | 27 `W` | week-of-month | number | 4 `E` | day-of-week | text | Tue; Tuesday; T `e/c` | localized day-of-week | number/text | 2; 02; Tue; Tuesday; T `F` | week-of-month | number | 3 `a` | am-pm-of-day | text | PM `h` | clock-hour-of-am-pm (1-12) | number | 12 `K` | hour-of-am-pm (0-11) | number | 0 `k` | clock-hour-of-am-pm (1-24) | number | 0 `H` | hour-of-day (0-23) | number | 0 `m` | minute-of-hour | number | 30 `s` | second-of-minute | number | 55 `S` | fraction-of-second | fraction | 978 `A` | milli-of-day | number | 1234 `n` | nano-of-second | number | 987654321 `N` | nano-of-day | number | 1234000000 `V` | time-zone ID | zone-id | America/Los_Angeles; Z; -08:30 `z` | time-zone name | zone-name | Pacific Standard Time; PST `O` | localized zone-offset | offset-O | GMT+8; GMT+08:00; UTC-08:00; `X` | zone-offset 'Z' for zero | offset-X | Z; -08; -0830; -08:30; -083015; -08:30:15; `x` | zone-offset | offset-x | +0000; -08; -0830; -08:30; -083015; -08:30:15; `Z` | zone-offset | offset-Z | +0000; -0800; -08:00; Info For more information on valid patterns, see the [Java DateTimeFormatter Patterns](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#patterns). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-migration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * Data migration [ Data migration ](./) Table of contents * Data migration process * Step 1 Define the data source * Step 2 Define data transfer target type * Step 3 Tables mapping * Available options * Target container and target table * Specify target container * Define a target table * Mapping * Transform column values * Configure * Column mapping * Table properties * Target DDL * Mapping Rules * Keyboard Shortcuts * Step 4 Extraction settings * Step 5 Data load settings * Step 6 Confirm * Step 7 Export completion notification * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Data migration process * Step 1 Define the data source * Step 2 Define data transfer target type * Step 3 Tables mapping * Available options * Target container and target table * Specify target container * Define a target table * Mapping * Transform column values * Configure * Column mapping * Table properties * Target DDL * Mapping Rules * Keyboard Shortcuts * Step 4 Extraction settings * Step 5 Data load settings * Step 6 Confirm * Step 7 Export completion notification 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Data transfer # Data migration Note This feature is available in Community, [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. **Data Migration** in DBeaver provides the functionality to transfer data between different databases or between tables within the same database. ## Data migration process¶ ### Step 1 Define the data source¶ To initiate the data migration, you need to select your data source. Follow the steps below: 1. Navigate to the [Database Navigator](../Database-Navigator/). 2. Select one or multiple tables that you want to export. 3. Right-click to open the context menu. 4. Choose **Export Data** from the options. ![](../images/dt/dt_migration/database-navigator-export_menu.png) Alternatively, you can export data from a custom SQL query. Execute the query and then choose **Export Data** from the results context menu. Tip You can start the migration through AI by sending a short request in AI chat. See [Data transfer actions](../Data-Transfer-Actions/) for supported commands. ### Step 2 Define data transfer target type¶ After selecting the data source, the next step is to specify the type of destination for the data transfer. Choose **Database** type as the data transfer target and press **Next**. ![](../images/dt/dt_migration/data-transfer-export-target.png) ### Step 3 Tables mapping¶ Once you have chosen **Database** as the transfer target type, the next step involves mapping data. This process includes specifying options, selecting the target container, and setting other configurations. Configure your data mapping settings and press **Next** to proceed to the next step. ![](../images/dt/dt_migration/data-transfer-tables-mapping.png) #### Available options¶ Buttons: Icon | Option | Description ---|---|--- ![](../images/dt/dt_migration/configure-button.png) | **Customize** | Opens additional settings. For details, see the Configure section. ![](../images/dt/dt_migration/preview-data-button.png) | **Preview data** | Shows a preview of the data to be transferred. ![](../images/dt/dt_migration/up-button.png) | **Up** | Moves the selected mapping closer to the head of the queue. ![](../images/dt/dt_migration/down-button.png) | **Down** | Moves the selected mapping closer to the tail of the queue. ![](../images/dt/dt_migration/mapp-with-ai-button.png) | **Map with AI** | Automatically maps source tables and columns to target names and types using AI. It analyzes sample data and schema structure, then suggests how to name the new tables and columns in the target database. In the Mapping Rules, you can choose how AI matches columns. ![](../images/dt/dt_migration/mapping-rules-button.png) | **Mapping Rules** | Choose how new tables and column names are transformed when transferring data. For details, see Mapping Rules section. Note **Map with AI** button is available only when AI is enabled. For setup instructions, see [AI Assistant setup](../AI-Assistance-settings/#ai- assistant-setup). Fields: Option | Description ---|--- **Target container** | Defines the database or schema for the data transfer. For more details, see the Target Container section. **Source** | Displays the names of selected tables and their columns. **Target** | Shows the names of destination tables. **Mapping** | Lists the available actions for data transfer. For more details, see the Mapping section. **Transform** | Allows for the transformation of column values during the data transfer. For more details, see the Transform section. #### Target container and target table¶ #### Specify target container¶ In the mapping table, click the **Target** cell for the desired **Source** row, then click the three dots button (![](../images/dt/dt_migration/target- button.png)) to select the container where the data will be transferred. #### Define a target table¶ ![](../images/dt/dt_migration/data-transfer-tables-mapping-target.png) You can specify the target table where the data will be transferred in multiple ways: * **Manual Entry** : Click on a cell in the **Target** column and manually enter the name of the table where you wish to transfer the data. * **Drop-down list** : Use the drop-down list next to the **Target** column to choose among the following options: * Pre-existing table names. * **Skip** : Skips the data transfer for this table. * **Browse** : Opens the **Choose Target Table** window * **Browse** button: Click the **Target** cell for the desired **Source** row, then click the three dots button (![](../images/dt/dt_migration/target-button.png)). ![](../images/dt/dt_migration/choose-target-table.png) #### Mapping¶ To change the mapping type, click a cell in the **Mapping** column of **Table mapping dialog box** and select the required mapping type. ![](../images/dt/dt_migration/data-transfer-tables-mapping-mapping-column.png) Action | Description ---|--- **Create** | Transfers source data into a newly created table or column in the target container. **Skip** | Does not transfer the source data. **Existing** | Transfers source data to an existing table in the target container. **Recreate** | Recreate the table, which means that the available data, keys, indexes, and other possible entities of the existing table will be lost. Tip If the cells are marked with ![](../images/dt/dbt_step3_Target_red.png), it means that in the target table, there are no columns with matching names, otherwise the names will be filled in automatically. #### Transform column values¶ You may also want to transform the values of some columns during the transfer. To do that, define column transformers by clicking on corresponding cells in the **Transform** column. You can choose one of three options: ![](../images/dt/dt_migration/data-transfer-tables-mapping-transform.png) Option | Description ---|--- **Set to NULL** | All values in the corresponding column are set to `null`. **Constant** | Sets column value to a constant value. **Expression** | Uses `JEXL` expressions to calculate the column's value. #### Configure¶ Click the **Configure** button to open the **Configure metadata structure** window. This window allows you to delve into additional settings are distributed across the following tabs: #### Column mapping¶ By navigating to the **Column mapping** , you can explore detailed mapping between the source and target columns. ![](../images/dt/dt_migration/configure-metadata-structure.png) Element | Description ---|--- **Source Column** | Contains names of columns existing in the selected source table. **Source Type** | Lists the data types assigned to the columns in the selected source table. **Target Column** | Contains names of columns in the target table where the data from the source column will be transferred. **Target Type** | Lists the data types that will be assigned to the columns in the target table. **Mapping** | Contains the list of actions to be applied to the data on data transfer. **Transform** | Displays transformations for the data in a column during the transfer. Important Data types that are supported in the source database may not be supported in the target, and vice versa. To set a data type for a target column, click the cell in the **Target Type** column and choose from the dropdown list. #### Table properties¶ By selecting the **Table properties** tab, you can modify properties of the target table, such as: Property | Description ---|--- **Tablespace** | Specifies the tablespace for the target table. **Partition By** | Sets the partitioning for the target table. **Comment** | Allows you to add comments to the target table. Note The availability of these settings may vary depending on the database you are using. #### Target DDL¶ By selecting the **Target DDL** tab, you can view the SQL script that will be executed during the data transfer. If you're exporting data to a new table or recreating an existing one, the tab will display the necessary SQL statements. If not, the DDL tab will remain empty. #### Mapping Rules¶ Clicking the **Mapping Rules** button opens a window that provides options for customizing how new tables and column names are transformed during the data transfer. ![](../images/dt/dt_migration/data-transfer-tables-mapping-mapping-rules.png) In the window, the following settings are available: Option | Description ---|--- **Name case** | Sets the letter casing for table and column names. Choices include **Default** , **Upper case** , and **Lower case**. **Replace spaces** | Determines how spaces in table and column names are handled. Options are: **Do not replace** , **Replace with underscore** , and **Remove, convert to CamelCase**. **Max data type length** | Sets the maximum length for data types. **Save current changes to global settings** | If checked, saves the current mapping rules to global settings. Otherwise, they will be saved at the data source settings level. **Global settings** | Opens the global settings window for **Names Mapping Rules**. Alternatively, to open global settings, go to **Window** -> **Preferences** -> **Connections** -> **Data Transfer** **Choose mapping strategy** ![](../images/commercial.png) | Defines how AI Custom Mapping matches columns between source and target tables. You can choose to match by **Data types** , **Column names** , or **Data types and column names**. This option is used when clicking the Map with AI button. In addition to using the Global settings button, you can also access these settings by navigating to **Window** -> **Preferences** -> **Connections** -> **Data Transfer**. Important After modifying the **Mapping Rules** settings, you will be prompted to confirm your changes. Modifying the **Mapping Rules** may result in the loss of names that were already changed. ### Keyboard Shortcuts¶ The following keyboard shortcuts for easy navigation within the mapping table area of the **Tables mapping** tab are supported: Shortcut | Action ---|--- `Up` | Move one row up. `Down` | Move one row down. `Right` | Expand list of source table columns. `Left` | Collapse list of source table columns. `Space` | Auto-assigns the target. `Del` | Sets mapping type to skip. ### Step 4 Extraction settings¶ After setting up your table mappings, the next step is to define how the data will be extracted from the source. The **Extraction settings** tab offers various options to optimize this process. Configure these settings to suit your specific data transfer requirements and press **Next**. ![](../images/dt/dt_migration/data-transfer-extraction-settings.png) Option | Description ---|--- **Maximum threads** | Defines the number of threads to be used for data transfer. **Extract type** | Use **Multiple queries** if database doesn't support resultset scrolling. You can also set the **Segment Size** value when this option is selected. **Open new connection(s)** | If checked, a new connection is established, ensuring data transfer does not affect other database operations. **Select row count** | Enables a progress bar to display data migration status. **Fetch size** | Indicates the number of rows fetched per server round trip, affecting extraction performance. ### Step 5 Data load settings¶ ![](../images/dt/dt_migration/data-transfer-data-load-settings.png) After configuring the extraction settings, you'll need to specify how the data will be loaded into the target database. The **Data load settings** tab provides a range of options to control this part of the process. Adjust the settings according to your needs and then press **Next**. **Data load settings** tab defines how the extracted data will be pushed to the target. The following options are available. Option | Description ---|--- **Transfer auto-generated columns** | Fill in or skip columns marked with the "autogenerated" status. Some databases accept values in such columns, while others will throw a syntax error. **Truncate target table(s) before load** | Select this checkbox only if you want all the data to be cleared from the target table. Be very careful with this option! **Disable referential integrity checks during the transfer** | Disabling constraints in the target table. This setting prevents database errors by temporarily disabling the constraints. However, please note that not all databases support this functionality. **Replace method** | Read our guide on [Data Import and Replace](../Data-Import-and-Replace/) to learn more about the replacing method option. **Log INSERT queries** | Records all `INSERT` queries in the [Query Manager](../Query-Manager/) (disabled by default). This may slow data transfer and increase the size of the Query Manager database. **Open new connection(s)** | Use this option to speed up data transfer. If selected, a new connection will be opened and the data transfer will not interfere with other calls to the database where data is being transferred to. **Use transactions** | This option allows you to speed up the data transfer and to define the number of rows for each transaction by setting the **Commit after insert of** parameter. **Do Commit after row insert** | Performing a commit after a certain number of inserted rows. This setting specifies that a commit operation should be executed after a specified number of rows have been inserted into the table. **Use multi-row value insert** | Use multi-row insert with extended values number for higher performance. Database-specific setting. **Skip bind values during insert** | This option can drastically increase performance for some drivers like Redshift by skipping a process of binding values and setting them directly, but it opens up a vulnerability to SQL injections. Not recommended if you are not sure of imported file contents. **Disable batches** | Select this checkbox if you want to disable the use of batch imports. The import will be made row by row. Enabling this function will show all import errors, but make the import process slower. **Ignore duplicate rows errors** | In the import process, if a database encounters a duplicate key from the import row in the target table, such errors are ignored, and the import operation continues without failure. **Use bulk load** | Bypasses transaction settings and loads the entire dataset using the native tool provided by the database. **Open table editor on finish** | If selected, the table editor is to be opened when data transfer is finished. **Show finish message** | If selected, a notification message will be shown when the transfer is finished. **Send results by E-Mail** | Sends data transfer results by E-Mail on finish. Read our guide to [using email to transfer data](../Data-transfer-email/) to learn more. ### Step 6 Confirm¶ ![](../images/dt/dt_migration/data-transfer-confirm.png) The final step before initiating the data transfer is the **Confirm** tab. This tab provides a summary of all configurations set up in the previous steps. It serves as a last review to ensure all settings are correct. Here is a table summarizing the configurations: Option | Description ---|--- **Source Container** | Displays the source container from which data will be pulled. **Source** | Shows the specific source within the container. **Target Container** | Displays the target container to which data will be pushed. **Target** | Shows the specific target within the container. **Source Settings** | Summarizes settings related to data extraction from the source. **Target Settings** | Summarizes settings related to data loading into the target. These settings are final and cannot be changed at this stage. If all configurations are correct, click **Finish** to start the data transfer. Tip You can save these configurations for future use and create a task related to the data transfer operation by selecting **Save[task](../Task-Management/)**. This option consolidates your settings into a reusable task. Upon clicking **Proceed** , the data transfer process will initiate. ### Step 7 Export completion notification¶ If there are no errors, you will see a notification window indicating the successful completion of the export task. You can continue working with your database during the export process, as it will be performed in the background. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-transfer-email/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * Data transfer via email [ Data transfer via email ](./) Table of contents * SMTP profile configuration * Setting up data transfer * Authorization troubleshooting * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * SMTP profile configuration * Setting up data transfer * Authorization troubleshooting 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Data transfer # Data transfer via email Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver offers a way to send data exported via [Data Transfer](../Data-transfer/) by email. ## SMTP profile configuration¶ First, you'll need to add an SMTP profile to send the email. Go to `Window` ⇒ `Preferences` ⇒ `General` ⇒ `Mail` and create a new profile. Parameters `Host` and `Port` may depend on the mail service you use. Use the latter if the service offers SSL and TLS ports. Gmail, for example, uses host `smtp.gmail.com` and port `587`. An example of a configured profile: ![](../images/ug/data-transfer/mail-smtp-configuration.png) Then you can use the `Test connection` button to verify that the host and credentials are valid. Please take a look at the troubleshooting section for more information on resolving common authorization problems. ## Setting up data transfer¶ After configuring at least one SMTP profile, you are able to set up the email notification for data transfer. To do this, follow these steps: 1. Create an [export task](../Data-transfer/#export-data). 2. Navigate to the **Output** page. 3. Ensure the **Send results by E-mail** option is checked. 4. Click the **Configure** button to set up email details. ![](../images/ug/data-transfer/mail-configuration.png) Within the email configuration, define the following settings: Setting | Description ---|--- **Send success reports** | Sends an email upon successful completion of a task. **Don't attach produced files** | Excludes the output files from the email notification. **Don't send if produced files are empty** | Prevents sending an email when the output files have no data. **Send failure reports** | Notifies by email if a task encounters a failure. **Bypass server certificate verification** | Disables server certificate validation, useful for self-signed certificates. Once the task runs, the recipients you configure will receive an email. The email will contain the exported file in the selected format if the appropriate options are enabled. ## Authorization troubleshooting¶ You may face various problems while setting up a new SMTP profile. Several common errors when using Gmail and solutions for them are described below: * `535-5.7.8 Username and Password not accepted`. Check that the username and password are correct. If you are confident that you have entered valid credentials, then try creating an app password. Read more at https://support.google.com/accounts/answer/185833 * `534-5.7.9 Application-specific password required`. You have two-factor authorization enabled. You will need to generate a special password for DBeaver to use. Read more at https://support.google.com/accounts/answer/185833 There were also several cases when the antivirus would block DBeaver from sending an email. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-transfer-external-storage/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * Data transfer external storage [ Data transfer external storage ](./) Table of contents * Exporting files to Google Drive * Exporting automatically * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Exporting files to Google Drive * Exporting automatically 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Data transfer # Data transfer external storage Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. Using [Data export](../Data-export/), you can export files to external storage, such as Google Drive. ## Exporting files to Google Drive¶ 1. Download and install Google Drive for desktop [here](https://www.google.com/drive/download/) 2. Configure Drive for streaming mode according to [this article](https://support.google.com/drive/answer/10838124) After that, in the data transfer wizard, change the output directory to the Drive directory. ## Exporting automatically¶ It can be achieved by using [Task Scheduler](../Task-Scheduler/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Data-transfer/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * Data transfer [ Data transfer ](./) Table of contents * Supported formats * Export data * Import data * Transfer data between database tables * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported formats * Export data * Import data * Transfer data between database tables 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Data transfer # Data transfer Data transfer is a crucial feature that enables you to export and import data in various formats as well as moving data between tables in the same or to different databases. The data transfer operation runs in the background, allowing you to continue working with your database during the export or import process. However, try to avoid changing data in the tables that have been selected for export or import until the process is complete. ## Supported formats¶ **Export** | **Import** ---|--- `Database` (table-to-table transfer) | `CSV` `CSV` | `XLSX` ![](../images/commercial.png) `DbUnit` | `XML` ![](../images/commercial.png) `HTML` | `Table` `JSON` | `Markdown` | `SQL` | `Source code` | `TXT` | `XML` | `Parquet` ![](../images/commercial.png) | `XLSX` ![](../images/commercial.png) | ## Export data¶ DBeaver allows you to export data from your database to various formats for use in other systems or applications. Info For more details, see [Data Export](../Data-export/). ![](../images/dt/dt-export-format.png) Depending on the selected format, exporting allows you to: * Export query results or entire tables. * Adjust data extraction, formatting, and encoding options. * Set options for delimiters, character encoding, or `NULL` values. * Use advanced features like multi-threading for large exports or adding data to existing files (e.g., Excel). * Save export configurations as tasks for repeated use. ## Import data¶ DBeaver enables you to import data from external sources into your database, making it easy to fill tables with new or updated information. Info For more details, see [Data Import](../Data-import/). ![](../images/dt/xlsx/dt-xlsx-import-source.png) Depending on the selected format, importing allows you to: * Import data into tables from external files or sources. * Map columns from source files to database tables. * Adjust file-specific settings like headers, date formats, and `NULL` handling. * Use advanced options like multi-sheet imports or specifying a timezone. * Save import configurations as tasks for repeated use. ## Transfer data between database tables¶ DBeaver provides data migration capabilities, allowing you to both export and import data between database tables. You can transfer data from one table to another within the same database or between different databases. For more detailed instructions, see [Data Migration](../Data-migration/). ![](../images/dt/dt_migration/data-transfer-export-target.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-Navigator/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * Database Navigator [ Database Navigator ](./) Table of contents * Navigation * Browse database objects * Filter database objects * Group database objects in folders * Simple and advanced view * Highlight object from editor * Show all databases * Toolbar * View menu * Context menu * Navigator preferences * Additional capabilities * Drag and drop from Database Navigator * Shortcuts * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Navigation * Browse database objects * Filter database objects * Group database objects in folders * Simple and advanced view * Highlight object from editor * Show all databases * Toolbar * View menu * Context menu * Navigator preferences * Additional capabilities * Drag and drop from Database Navigator * Shortcuts 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Database Navigator # Database Navigator **Database Navigator** is the main tool in DBeaver for working with database structure and data. It shows a tree of objects - like connections, schemas, tables, and views - based on your database type. ![](../images/ug/Database-Navigator.png) Tip If you don’t see Database Navigator, go to **Window - > Database Navigator** to open it. ## Navigation¶ ### Browse database objects¶ Use the tree in **Database Navigator** to view and explore databases. Each connection shows its own set of objects - schemas, tables, views, procedures, and more. Expand a connection to access its contents. Click any object to open it in the appropriate editor or viewer. ### Filter database objects¶ Use the filter bar above the navigator tree to search and filter database objects. Start typing to highlight matching items. The filter supports partial matches and updates results instantly. You can also filter using the view options or context menu. ![](../images/ug/filter-database-object.png) Tip The filter applies only to expanded nodes. For details, see [Filter database objects](../Filter-Database-Objects/). ### Group database objects in folders¶ Use folders to organize connections: * Right-click in the tree and select **Create - > New Folder** to add a new folder. * Drag and drop connections or objects into folders to group them. ![](../images/ug/group-database-objects-in-folders.png) Tip You can also create subfolders within existing folders to further organize your database objects. ### Simple and advanced view¶ Switch between **Simple** , **Advanced** , or **Custom** view to control how much detail is shown in **Database Navigator**. Use this option to simplify the tree or show all available objects, depending on your needs. ![](../images/ug/simple-and-advanced-view.png) Info For details, see [Simple and advanced view](../Simple-and-Advanced-View/). ### Highlight object from editor¶ Use **Link with editor** button ![](../images/ug/Link-with-Editor-icon.png) to highlight the object currently opened in the [SQL Editor](../SQL-Editor/) or [Data Editor](../Data-Editor/) in **Database Navigator**. When enabled, **Database Navigator** selects and scrolls to the schema that contains the active object. Toggle this option from the top toolbar of the **Database Navigator**. ![](../images/ug/link-with-editor.png) ### Show all databases¶ Enable **Show all databases** in the connection settings to display all databases in **Database Navigator**. Some databases (such as [PostgreSQL](../Database-driver-PostgreSQL/)) may show only the active database or a limited set of schemas by default. ![](../images/ug/show-all-databases.png) ## Toolbar¶ The toolbar contains buttons for the most basic and frequently used commands: Icon | Menu item | Description ---|---|--- ![](../images/ug/Collapse-All-icon.png) | **Collapse All** | Collapses all tree items to the root level. ![](../images/ug/Link-with-Editor-icon.png) | **Link with editor** | Syncs the selected item in active editor with schema in the Database Navigator. ![](../images/ug/show-all-connections-button.png) | **Show all connections/Show connected only** | Filters the tree to show either all connections or only connected ones. ![](../images/ug/filter-mode-button.png) | **Filter mode** | Cycles through object filter levels: connections, catalogs and schemas, or individual objects. [Read more](../Filter-Database-Objects/) ![](../images/ug/View-menu-icon.png) | **View menu** | Opens additional options. Read more ## View menu¶ Click the **View Menu** button (![](../images/ug/View-menu-icon.png)) in the upper-right corner of the **Database Navigator** panel to open additional options. Icon | Menu item | Description ---|---|--- ![](../images/ug/new-connection-wizard-button.png) | **New Database Connection** | Opens the connection wizard. ![](../images/ug/driver-manager-button.png) | **Driver Manager** | Opens the driver manager for configuring drivers. | **Active Project** | Switches between projects. ![](../images/ug/Create-new-folder-button.png) | **New Folder** | Creates a new folder in the current project. ![](../images/ug/Collapse-All-icon.png) | **Collapse All** | Collapses all nodes in the tree. ![](../images/ug/Link-with-Editor-icon.png) | **Link with editor** | Syncs the selected object with the active editor tab. ![](../images/ug/Configure-columns-visibility-icon.png) | **Preferences** | Opens DBeaver settings. ![](../images/ug/Refresh-button.png) | **Refresh Projects** | Reloads all projects and folders. Tip Use the **View Menu** for project-level actions and layout options - it’s different from the context menu, which changes based on the selected object. ## Context menu¶ Right-click an object in the **Database Navigator** tree to open its context menu. The menu shows different items depending on the database type and selected object. Menu item | Description ---|--- **Create** | Creates objects like connection, folder, and other. **Open folder** | Opens the selected folder in a new view. **Copy** | Copies the selected object. **Paste** | Pastes the copied object into the selected folder or node. **Delete** | Deletes the object. **Warning** : This action removes the object from the database or file system. It can't be undone. **Rename** | Opens a dialog to rename the object. **Refresh** | Refreshes the selected node and its children. **Connect** | Connects to the database. **Invalidate/Reconnect** | Reconnects if the connection is broken. **Disconnect** | Disconnects from the database. **SQL Editor** | Opens new script, last edited script for this connection. **Edit connection** | Opens the connection settings. **Connection view** | Lets you switch between **Simple** , **Advanced** , or **Custom** views. [Read more](../Simple-and-Advanced-View/) **View`[object]`** | Opens the object in a viewer. **Edit`[object]`** | Opens the object in an editor. **Create new`[object]`** | Starts creating a new object. **Filter** | Opens filtering options for the selected object: \- Hide `[object]` \- Show only `[object]` \- Configure `[object]` filter \- Toggle filter \- Clear filter [Read more](../Configure-Filters/) **Copy Advanced Info** | Copies the object’s full name. **Read data in SQL console** | Opens a console to preview data from the object. **Compare/Migrate** | Opens the [export](../Data-compare/) wizard. **Generate SQL** | Opens options to generate SQL statements: \- `SELECT` \- `INSERT` \- `UPDATE` \- `DELETE` \- `MERGE` \- `DDL` **Export Data** | Opens the [export](../Data-export/) wizard. **Import Data** | Opens the [import](../Data-import/) wizard. **Tools** | Opens tools like [Dashboards](../Dashboards/), [Tasks](../Task-Management/), [Backup and restore](../Backup-Restore/). Tip The available menu items change depending on the selected object and database. ## Navigator preferences¶ You can control how the **Database Navigator** behaves and displays objects. These settings are available in **Window - > Preferences -> User Interface -> Navigator**. Setting name | Description ---|--- **Show connection host name** | Show target database host name or tunnel host name next to the connection name **Show objects description** | Shows object (table, column, etc.) description next to it **Show statistics info** | Show statistics (e.g. table size) on the right side of navigator **Show action icons** | Show action icons for database elements **Show placeholders for special folders** | Show special folders (e.g. Scripts) even if they were not created yet **Folders first** | Show folders before regular elements **Show child count in navigator** | Display the number of children for expanded folders in the navigator tree **Order elements alphabetically** | Order navigator nodes (not folders) alphabetically **Case-insensitive alphabetical sorting** | Order navigator nodes without case sensitivity, for example, `A,a,B,b` **Set connection color for all elements** | Color all elements according to connection type, otherwise set color only for connection node itself **Show object modifiers in tree** | Show object modifiers (e.g. column data type) in the tree right after the name **Show tooltips** | Show tooltips in navigator views **Show file contents in tooltips** | Show file (e.g. SQL script) contents in tooltips **Show grid lines in lists** | Displays grid lines between rows and columns in navigator and editor lists for better readability **Double-click on node** | \- **Open Properties** \- opens the object properties tab \- **Expand / Collapse** \- expands or collapses the selected node in the tree **Double-click on connection** | \- **Open Properties** \- opens the connection properties \- **Connect / Disconnect** \- connects or disconnects from the database \- **Open SQL Editor** \- opens the SQL Editor \- **Open new SQL Editor** \- opens a new SQL Editor tab \- **Expand / Collapse** \- expands or collapses the connection node **Default editor page** | \- **Last opened** \- opens the editor on the page that was active last time \- **Properties** \- opens the Properties page \- **Data** \- opens the Data tab \- **Diagram** \- opens the Diagram tab **Expand navigator tree on connect** | Expand the Navigator tree for active elements on connect **Save database navigator filter** | Saves object filter specified in the database navigator view between application restarts **Elements fetch size** | Children elements fetch size for long lists. Rest of elements can be read by double clicking on the last element **Restore navigator state up to depth** | Restore navigator state on startup up to depth Tip You can also configure these settings through preference files without opening the app. For details, see [Manage application preferences](../Admin-Manage- Preferences/). ## Additional capabilities¶ ### Drag and drop from Database Navigator¶ You can drag objects from **Database Navigator** into the **SQL Editor** to quickly add their names to a query. Note After you drop an object, it stays selected in the editor. If you run the query right away, only the selected part runs - which often causes an error because it's not a complete query. Click in the editor to deselect the object before running the query. ### Shortcuts¶ You can navigate, filter, and edit objects faster with keyboard shortcuts. Info For a full list, see [Shortcuts](../Shortcuts/#database-navigator). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-Object-Editor/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * Database object editor [ Database object editor ](./) Table of contents * Tabs * Database object path * Content area and Toolbar * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Tabs * Database object path * Content area and Toolbar 1. [DBeaver](/docs/dbeaver) 2. DBeaver configuration # Database object editor The Database object editor, or Metadata editor, is a general-purpose tool that provides a comprehensive interface for working with various database objects such as tables, views, and schemas. It includes several key components that help you interact with database objects: * **Tabs** : Provide access to specific editors, such as Properties, Data, and Diagrams. * **Database object path** : Displays the hierarchy of parent entities. * **Content area** : Shows detailed information about the selected object. * **Toolbar** : Offers tools specific to each tab to streamline tasks. To open the Metadata editor for an object, in the [Database Navigator](../Database-Navigator/) or in the [Projects](../Projects/) view: * Double-click the database object * Click the database object and press `Enter` or `F4` ![](../images/ug/Metadata-editor.png) ## Tabs¶ **Tab** | **Description** ---|--- [**Properties**](../Properties-Editor/) | Available for all objects, shows the properties of the database object and its sub-entities. [**Data**](../Data-Editor/) | Appears for tables and views, represents the Data Editor. [**Diagram**](../ER-Diagrams/) | Appears for tables and schemas, displays ERD (Entity-Relationship Diagrams). ## Database object path¶ The object's path shows the chain of all its parent entities. The entities are clickable: clicking an entity in the path, depending on its nature, either shows its children or opens an editor or a settings window. ## Content area and Toolbar¶ The Content Area and Toolbar are key parts of the Properties tab. The Content Area shows information about a database object and things like its sub-parts or DDL. The Toolbar has different tools on each tab to help with different tasks. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-Structure-Diagrams/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * Database structure diagrams [ Database structure diagrams ](./) Table of contents * Relationship Notation * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Relationship Notation 1. [DBeaver](/docs/dbeaver) 2. Entity relation diagrams # Database structure diagrams You can view a database structure in the standard ERD (Entity Relation Diagram) form. Diagrams are available for all tables and schemas (databases). The ER diagram for a table shows the table itself and its relations with other tables inside the schema. To view the Diagram for a table or view, double- click the table or view in the [Database Navigator](../Database-Navigator/) and then, in the [Database Object Editor](../Database-Object-Editor/), switch to the **ER Diagram** tab: ![](../images/ug/ERD-Db-Structure.png) To view the Diagram for a full database schema, double-click the schema name in the Database Navigator or the previous node in the path (usually - **Tables**): ![](../images/ug/ERD-previous-node.png) ![](../images/ug/ERD-DB-Schema.png) Note Table and schema diagrams are read-only. You can rearrange the layout, drag-n- drop elements inside a diagram but you cannot save the changes state or delete/add anything. This is because the diagrams represent the actual state of databases. ## Relationship Notation¶ Lines representing the relationship between tables can look different depending on the nature of the relationship. Please note that any line can have only one beginning and one end. We may have links between two tables not only for one pair of attributes, which means that several associations will be displayed: ![image](https://user- images.githubusercontent.com/49681450/199467855-e65fa503-e5cc-47e1-96bc-92556814691a.png) Notation | Description ---|--- ![image](https://user-images.githubusercontent.com/49681450/199478029-2d466c7d-c445-41be-8ee0-2738c257fa78.png) | A solid line means that the foreign key column in one table is a primary key in another table ![image](https://user-images.githubusercontent.com/49681450/199477732-a008f182-5b47-41c2-b9e8-a5ab1361fe98.png) | A dashed line means that the foreign key column is not a primary key but a regular column in another table ![image](https://user-images.githubusercontent.com/49681450/199476816-ed9abb97-0941-42ea-a003-f9fcc5b764e6.png) | A black dot is used as the start of the line ![image](https://user-images.githubusercontent.com/49681450/199477303-dc5d4c6e-d03a-47df-bfd9-f5f285500b16.png) | A diamond is used at the end of the link when the column in the source table is optional (there is no NOT NULL) A one-to-one relationship is always a solid line due to the unique primary key - foreign key relationship: ![image](https://user- images.githubusercontent.com/49681450/199478724-26ea5405-ba4d-4409-9802-c89ec01a0295.png) A dashed line is for the one-to-many relationship: ![image](https://user- images.githubusercontent.com/49681450/199481540-f3d4a8f8-e328-4364-b02f-c46b243e5a80.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-AlloyDB-for-PostgreSQL/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * AlloyDB for PostgreSQL [ AlloyDB for PostgreSQL ](./) Table of contents * AlloyDB specialty * Setting Up * AlloyDB connection settings * Connection details * Driver properties * ODBC and JDBC driver configuration * Secure connection configurations * Secure Storage with Secret Providers * Powering AlloyDB with DBeaver * AlloyDB database objects * AlloyDB additional features in DBeaver * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * AlloyDB specialty * Setting Up * AlloyDB connection settings * Connection details * Driver properties * ODBC and JDBC driver configuration * Secure connection configurations * Secure Storage with Secret Providers * Powering AlloyDB with DBeaver * AlloyDB database objects * AlloyDB additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # AlloyDB for PostgreSQL Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. AlloyDB for PostgreSQL is a fully managed database service, tailored for demanding enterprise workloads. It blends the reliability and familiarity of PostgreSQL with Google's advanced technology. This service delivers enhanced performance, scalability, and high availability, making it an ideal choice for critical business applications. For more detailed information, visit [Google AlloyDB](https://cloud.google.com/alloydb?hl=en) webpage. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `AlloyDB` option to connect to the AlloyDB database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/alloydb/alloydb-drivers.png) ## AlloyDB specialty¶ AlloyDB for PostgreSQL is a fully managed database service, tailored for demanding enterprise workloads. It blends the reliability and familiarity of PostgreSQL with Google's advanced technology and supports rich metadata structures, including tables, views, indexes, sequences, and various data types. Its setup in DBeaver mostly replicates the PostgreSQL driver configuration. AlloyDB includes support for SQL triggers, stored procedures, and user-defined functions, enhancing its utility for complex data operations. For a more comprehensive understanding of AlloyDB, please refer to the [official documentation](https://cloud.google.com/alloydb/docs). ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for AlloyDB. Note The connection process in DBeaver utilizes the standard PostgreSQL driver, tailored to interact with the AlloyDB service, highlighting its cloud-based characteristics. ## AlloyDB connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to an AlloyDB database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your AlloyDB database. 1. The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/alloydb/alloydb-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your AlloyDB database. **URL** | If you are connecting via URL, enter the URL of your AlloyDB database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your AlloyDB database here. **Database** | Enter the name of the AlloyDB database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [PostgreSQL Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) \- [PostgreSQL PgPass Authentication](../Authentication-PostgreSQL-Pgpass/) \- [PostgreSQL SSPI Authentication (Windows SSO)](../Authentication- PostgreSQL-SSPI/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Local Client** | Specify the local client, see our article about [local client configuration](../Local-Client-Configuration/). **Session role** | This option allows you to define a specific role that your database session assumes upon connection. Setting a session role can be useful for managing permissions and access control within your AlloyDB database. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The **Advanced** tab of the connection settings offers additional options that allow you to customize your further connection to the AlloyDB database. ![](../images/database/alloydb/alloydb-connection-settings.png) Field | Description ---|--- **Show template databases** | Displays template databases. This option is available when **Show all databases** is checked. **Show databases unavailable for connection** | Show databases not available for connection in database list. This option is available when **Show all databases** is checked. **Show databases statistics** | Displays statistics for databases. **Read all data types** | Reads all data types from the server (including arrays). **Read table keys with columns** | Enable reading table constraints during the column reading stage to ensure accurate recognition of keys. Note that this setting may decrease metadata loading performance. **Replace legacy timezone** | Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like **Europe/Kyiv** or **Asia/Calcutta**. Only these two timezones are affected. **Show`$$` quote as** | Displays `$$` quotes as code blocks or strings. **Show`$tagName$` quote as** | Displays `$tagName$` quotes as code blocks or strings. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your AlloyDB connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Driver properties¶ While managing AlloyDB with DBeaver, it's important to understand that the underlying driver is the standard PostgreSQL JDBC and ODBC driver. The settings for AlloyDB **Driver properties** enable you to adjust the performance of the JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your AlloyDB database. For a complete walkthrough on setting up JDBC and ODBC drivers properties, you can refer to the official [JDBC documentation](https://jdbc.postgresql.org/documentation/use/) and [ODBC documentation](https://odbc.postgresql.org/). These guides detail each driver's properties and how they can be used to optimize AlloyDB database connections. You can customize the driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your AlloyDB database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC driver configuration¶ DBeaver provides extensive capabilities for managing AlloyDB database connections via ODBC/JDBC drivers. This functionality enables you to connect to your AlloyDB database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure connection configurations¶ DBeaver supports secure connections to your AlloyDB database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering AlloyDB with DBeaver¶ DBeaver provides a host of features designed for AlloyDB databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## AlloyDB database objects¶ DBeaver lets you view and manipulate a wide range of AlloyDB database objects. DBeaver has extensive support for various AlloyDB metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Data types * Tables * Columns * Constraints * Indexes * Foreign Keys * Dependencies * References * Partitions * Triggers * Rules * Policies * Foreign Tables * Views * Materialized Views * Functions * Sequences * Data types * Aggregate functions * Event Triggers * Extensions * Storage * Tablespaces * Roles * Administer * Jobs * Session Manager * Lock Manager ## AlloyDB additional features in DBeaver¶ DBeaver provides additional features compatible with AlloyDB, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Lock Management | [Lock Manager](../Lock-Manager/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) | [Query Execution plan](../Query-Execution-Plan/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Amazon-Athena/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * Athena [ Athena ](./) Table of contents * Athena specialty * Setting up * Athena connection settings * Connection details * Secure connection configurations * Secure Storage with Secret Providers * Powering Athena with DBeaver * Athena database objects * Athena additional features in DBeaver * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Athena specialty * Setting up * Athena connection settings * Connection details * Secure connection configurations * Secure Storage with Secret Providers * Powering Athena with DBeaver * Athena database objects * Athena additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # Athena This documentation outlines the process of configuring and using AWS Athena with DBeaver. To manage databases using AWS Athena in DBeaver, establishing a connection is essential. This is done by selecting the `Athena` option in the database connection settings of DBeaver. For those new to this process, our [Creating a Connection](../Create-Connection/) article provides detailed guidance. ![](../images/database/athena/athena-drivers.png) Info DBeaver can connect to the AWS Athena databases using the [Cloud Explorer](../AWS-Cloud-Explorer/). ![](../images/ug/cloud-explorer/aws-cloud-services.png) ## Athena specialty¶ AWS Athena, as an analytical database service, has limitations compared to traditional relational databases. It does not support real-time data changes, such as adding or updating data. Also, Athena cannot modify data using `DELETE` or `UPDATE` commands. It lacks constraint enforcement like primary keys and foreign keys. For more detailed information, refer to the [AWS Athena database documentation](https://docs.aws.amazon.com/athena/). Important In DBeaver, AWS Athena is read-only. For a detailed overview of the supported features and capabilities of AWS Athena within DBeaver, please see the section on Powering Athena with DBeaver. Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, Proxies, and Kubernetes. ## Athena connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Athena database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Athena database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/athena/athena-connection-main.png) Field | Description ---|--- **Region** | Specify the AWS region where your Athena database is located, such as `us-west-1`. This should match the region of the S3 bucket used for storing query results. **S3 location** | Enter the output location for query results in the format `s3://aws-athena-query-results-[your-account-id]-[region]/`. Replace `[your-account-id]` with your actual AWS account ID and `[region]` with the region code, for example, `s3://aws-athena-query-results-80980980-us-east-1/`. Ensure you have the necessary permissions set for this S3 location. **Browse** | Click to open a dialog that allows you to navigate and select an S3 bucket through DBeaver's interface. **Show catalogs** | Check this option if you want to view the data catalog in the DBeaver connection. This will show the databases and tables defined in Athena's data catalog. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Database native](../Authentication-Database-Native/) \- [AWS IAM](../AWS-Credentials/) \- [DBeaver Profile](../Authentication-DBeaver-profile/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. For detailed guide on driver properties please refer to the [official AWS Athena documentation](https://s3.amazonaws.com/athena-downloads/drivers/JDBC/SimbaAthenaJDBC-2.0.25.1001/doc/Simba+Athena+JDBC+Connector+Install+and+Configuration+Guide.pdf). ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Athena connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Secure connection configurations¶ DBeaver supports secure connections to your Athena database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Athena with DBeaver¶ DBeaver provides a host of features designed for Athena databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ### Athena database objects¶ DBeaver lets you view a range of Athena database objects, such as: * Schemas * Tables * Columns * Views * Columns * Procedures ### Athena additional features in DBeaver¶ DBeaver provides additional features compatible with Athena, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Schema Management | [Schema Compare](../Schema-compare/) ![](../images/commercial.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Amazon-Redshift/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * Redshift [ Redshift ](./) Table of contents * Select driver * Redshift specialty * Setting up * Redshift connection settings * Connection details * Redshift driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Redshift with DBeaver * Redshift database objects * Redshift additional features in DBeaver * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Select driver * Redshift specialty * Setting up * Redshift connection settings * Connection details * Redshift driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Redshift with DBeaver * Redshift database objects * Redshift additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # Redshift This section provides guidance on configuring and using AWS Redshift with DBeaver. AWS Redshift is a fully managed data warehouse service known for its high performance and scalability in handling large datasets. An important aspect of Redshift is that it is based on open standard PostgreSQL, which means it shares numerous settings and capabilities similar to PostgreSQL databases. For detailed information about AWS Redshift's features, visit the [AWS Redshift documentation](https://aws.amazon.com/redshift/features/). Before you start, you must create a connection in DBeaver and select Redshift. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. ## Select driver¶ DBeaver interacts with the AWS Redshift server using a specific driver. It supports all versions of AWS Redshift, but the correct driver must be selected: * **Redshift** – Recommended for most use cases. * **Redshift Serverless** – Use only if connecting to Redshift Serverless. This driver has known issues with multithreading and handling large result sets. Important Starting with version `25.0`, **Redshift Serverless** uses a separate driver. The default **Redshift** driver still works for standard clusters. If your Serverless connection broke after the update, follow this steps: 1. Choose connection in the [Database Navigator](../Database-Navigator/). 2. Navigate to **Database** in the [Menu bar](../Application-Window-Overview/#menu-bar). 3. Click **Change Connection(s) driver** and choose **Redshift Serverless**. ![](../images/database/redshift/redshift-drivers.png) Info DBeaver can connect to the AWS Redshift databases using the [Cloud Explorer](../AWS-Cloud-Explorer/). ![](../images/ug/cloud-explorer/aws-cloud-services.png) ## Redshift specialty¶ AWS Redshift is an optimized database service designed for large-scale data warehousing and analytics, supporting a wide array of SQL operations. Its foundation in PostgreSQL, through a modified version tailored for its query processing, allows Redshift to support many of the standard SQL features of PostgreSQL. In addition to its PostgreSQL roots, a key feature of AWS Redshift is its columnar data storage. This approach to data storage is particularly efficient for analytics, as it allows for faster retrieval of specific columns, optimizing the performance for query-heavy workloads typically associated with data warehousing. However, it is important to note that AWS Redshift does not fully support referential integrity constraints, such as foreign keys. For more detailed information, refer to the [AWS Redshift database documentation](https://docs.aws.amazon.com/redshift/). For a detailed overview of the supported features and capabilities of AWS Redshift within DBeaver, please see the section on Powering Redshift with DBeaver. Warning The Redshift Serverless may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per-request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable- metadata-queries). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, SSL, Proxies, Kubernetes, and the setup of ODBC/JDBC drivers for Redshift. ## Redshift connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Redshift database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Redshift database. 1. The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/redshift/redshift-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Redshift database. **URL** | If you are connecting via URL, enter the URL of your Redshift database here. This field is hidden if you are connecting via the host. **Host/Instance** | If you are connecting via host or instance, enter the address of your AWS Redshift database here. **Database** | Enter the name of the Redshift database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Port** | Enter the port number for your Redshift database. The default Redshift port is `5439`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [PostgreSQL PgPass](../Authentication-PostgreSQL-Pgpass/) \- [AWS Redshift IAM](../AWS-Credentials/) ![](../images/commercial.png) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [PostgreSQL Kerberos](../Kerberos-Authentication/) ![](../images/commercial.png) \- [PostgreSQL SSPI (Windows SSO)](../Authentication-PostgreSQL-SSPI/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The **Advanced** tab of the connection settings offers additional options that allow you to customize your further connection to the Redshift database. ![](../images/database/redshift/redshift-connection-second-page.png) Field | Description ---|--- **Show template databases** | Displays template databases. This option is available when **Show all databases** is checked. **Show databases not available for connection** | Show databases not available for connection in database list. This option is available when **Show all databases** is checked. **Show databases statistics** | Displays statistics for databases. **Read all data types** | Reads all data types from the server (including arrays). **Read table keys with columns** | Enable reading table constraints during the column reading stage to ensure accurate recognition of keys. Note that this setting may decrease metadata loading performance. **Replace legacy timezone** | Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like **Europe/Kyiv** or **Asia/Calcutta**. Only these two timezones are affected. **Show`$$` quote as** | Displays `$$` quotes as code blocks or strings. **Show`$tagName$` quote as** | Displays `$tagName$` quotes as code blocks or strings. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Redshift connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Redshift driver properties¶ The settings for Redshift **Driver properties** enable you to adjust the performance of the Redshift JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Redshift database. For a complete walkthrough on setting up Redshift JDBC and ODBC drivers properties, you can refer to the official [AWS Redshift JDBC documentation](https://docs.aws.amazon.com/redshift/latest/mgmt/jdbc20-configuration- options.html) and [AWS Redshift ODBC documentation](https://docs.aws.amazon.com/redshift/latest/mgmt/odbc20-configuration- options.html). These guides detail each driver's properties and how they can be used to optimize Redshift database connections. You can customize the Redshift driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Redshift database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing Redshift database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Redshift database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Redshift database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Redshift with DBeaver¶ DBeaver provides a host of features designed for Redshift databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## Redshift database objects¶ DBeaver lets you view and manipulate a wide range of Redshift database objects. DBeaver has extensive support for various Redshift metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Tables * Columns * Constraints * Foreign Keys * Dependencies * References * Views * Functions * Data types * Aggregate functions * Users ![](../images/commercial.png) * Groups ![](../images/commercial.png) * Roles ![](../images/commercial.png) * Administer * Jobs * Session Manager * Datashares ![](../images/commercial.png) * Objects ![](../images/commercial.png) * Consumers ![](../images/commercial.png) ## Redshift additional features in DBeaver¶ DBeaver provides additional features compatible with Redshift, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Data Visualization | [ERD Guide](../ER-Diagrams/) | [Query Execution plan](../Query-Execution-Plan/) Session Management | [Session Manager](../Session-Manager-Guide/) Schema Management | [Schema Compare](../Schema-compare/) ![](../images/commercial.png) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) ![](../images/commercial.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Amazon-Timestream/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * Timestream [ Timestream ](./) Table of contents * Timestream specialty * Setting up * Timestream connection settings * Connection details * Timestream driver properties * Secure connection configurations * Secure Storage with Secret Providers * Powering Timestream with DBeaver * Timestream database objects * Timestream features in DBeaver * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Timestream specialty * Setting up * Timestream connection settings * Connection details * Timestream driver properties * Secure connection configurations * Secure Storage with Secret Providers * Powering Timestream with DBeaver * Timestream database objects * Timestream features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # Timestream Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This documentation outlines the process of configuring and using AWS Timestream with DBeaver. For more information, visit the official [AWS Timestream website](https://aws.amazon.com/timestream/). To manage databases using AWS Timestream in DBeaver, establishing a connection is essential. This is done by selecting the `Timestream` option in the database connection settings of DBeaver. For those new to this process, our [Creating a Connection](../Create-Connection/) article provides detailed guidance. ![](../images/database/timestream/timestream-drivers.png) Info DBeaver can connect to the AWS Timestream databases using the [Cloud Explorer](../AWS-Cloud-Explorer/). ![](../images/ug/cloud-explorer/aws-cloud-services.png) ## Timestream specialty¶ AWS Timestream, while optimized for time-series data, lacks some features common in traditional relational databases. It does not have features like constraints, foreign keys, triggers, views, or complex joins, and sub-queries limit DBeaver's capabilities when working with Timestream. For more detailed information, refer to the AWS Timestream database documentation. Due to the absence of certain features in AWS Timestream, there is an inability to link tables, automate tasks based on database changes, create virtual tables from queries, or conduct an in-depth analysis of how data is related within Timestream. For more detailed information, refer to the [AWS Timestream database documentation](https://docs.aws.amazon.com/timestream/). Important In DBeaver, AWS Timestream is read-only. For a detailed overview of the supported features and capabilities of AWS Timestream within DBeaver, please see the section on Powering Timestream with DBeaver. Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, Proxies, and Kubernetes. ## Timestream connection settings¶ This subsection will outline the settings for establishing a direct connection to a Timestream database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Timestream database. The connection settings page requires you to fill in specific fields to establish the initial connection. ![](../images/database/timestream/timestream-connection-main.png) Field | Description ---|--- **Region** | Specify the AWS region where your Timestream database is located, such as `us-west-1`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [AWS Timestream IAM](../AWS-Credentials/) \- [DBeaver Profile](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. For a detailed guide on driver properties, please refer to the [official AWS Timestream documentation](https://docs.aws.amazon.com/timestream/latest/developerguide/JDBC.connection-properties.html). ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Timestream connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Timestream driver properties¶ The settings for Timestream **Driver properties** enable you to adjust the performance of the Timestream JDBC driver. For a complete walkthrough on setting up Timestream JDBC driver properties, you can refer to the official [Timestream JDBC documentation](https://github.com/awslabs/amazon-timestream-driver- jdbc#optional-connection-properties). These guides detail each driver's properties and how they can be used to optimize Timestream database connections. You can customize the Timestream driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Timestream database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## Secure connection configurations¶ DBeaver supports secure connections to your Timestream database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Timestream with DBeaver¶ DBeaver provides a host of features designed for Timestream databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ### Timestream database objects¶ DBeaver lets you view a few of the Timestream database objects, such as: * Schemas * Tables * Columns ### Timestream features in DBeaver¶ DBeaver provides the following features compatible with Timestream, but not exclusive to it: * **Data Export** : Enables the exportation of data. See [Data Export](../Data-export/) for more details. * **Graph Construction** : Allows the building of detailed and informative graphs. ![](../images/database/timestream/timestream-graph.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Aurora-DSQL/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * Aurora DSQL [ Aurora DSQL ](./) Table of contents * Aurora DSQL specifics * Setting up * Aurora DSQL connection settings * Main tab * Advanced tab * Driver properties tab * Connection details * Aurora DSQL driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Aurora DSQL with DBeaver * Aurora DSQL database objects * Additional features * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Aurora DSQL specifics * Setting up * Aurora DSQL connection settings * Main tab * Advanced tab * Driver properties tab * Connection details * Aurora DSQL driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Aurora DSQL with DBeaver * Aurora DSQL database objects * Additional features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # Aurora DSQL ![tag-outline](/docs/includes/icons/tag-outline.svg)Since 25.3 This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This documentation outlines how to configure and use **Aurora DSQL** with DBeaver. For information on the service itself, see the official [Amazon Aurora DSQL documentation](https://docs.aws.amazon.com/aurora-dsql/). To get started, select the `Aurora DSQL` driver when creating a new connection. For step-by-step instructions, see [Creating a Connection](../Create-Connection/). ![](../images/database/aurora-dsql/aurora-dsql-drivers.png) Info DBeaver can connect to Aurora DSQL using the [Cloud Explorer](../AWS-Cloud- Explorer/). ![](../images/ug/cloud-explorer/aws-cloud-services.png) ## Aurora DSQL specifics¶ Aurora DSQL is a serverless, distributed SQL database built for always- available cloud workloads. AWS handles infrastructure, scaling, and maintenance, so you don’t manage servers or plan capacity. It’s PostgreSQL-compatible and keeps a familiar SQL experience, while adding cloud-native features like automatic scaling, and built-in high availability. Aurora DSQL is designed for fast multi-Region reads and writes, with strong data consistency and minimal downtime. Compared to a traditional PostgreSQL database, some system and administrative behaviors are different. These changes enable seamless scaling and high availability across Regions, which is the core strength of Aurora DSQL. ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, SSL, Proxies, Kubernetes, and the setup of JDBC driver for Aurora DSQL. ## Aurora DSQL connection settings¶ Configure the connection settings to connect DBeaver to your Aurora DSQL database. ### Main tab¶ The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/aurora-dsql/aurora-dsql-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **URL** | If you are connecting via URL, enter the URL of your Aurora DSQL database here. This field is hidden if you are connecting via the host. **Host/Instance** | If you are connecting via host or instance, enter the address of your Aurora DSQL database here. **Database** | Enter the name of the Aurora DSQL database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Port** | Enter the port number for your Aurora DSQL database. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Aurora DSQL Auth](../AWS-Credentials/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) \- [PostgreSQL Kerberos](../Kerberos-Authentication/) \- [PostgreSQL PgPass](../Authentication-PostgreSQL-Pgpass/) \- [PostgreSQL SSPI (Windows SSO)](../Authentication-PostgreSQL-SSPI/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Advanced tab¶ The **Advanced** tab of the connection settings offers additional options that allow you to customize your further connection to the Aurora DSQL database. ![](../images/database/aurora-dsql/aurora-dsql-connection-advanced.png) Field | Description ---|--- **Session Role** | This option allows you to define a specific role that your database session assumes upon connection. Setting a session role can be useful for managing permissions and access control within your Aurora DSQL database. **Local Client** | Specify the local client, see our article about [local client configuration](../Local-Client-Configuration/). **Show template databases** | Displays template databases. This option is available when **Show all databases** is checked. **Show databases unavailable for connection** | Show databases not available for connection in database list. This option is available when **Show all databases** is checked. **Show databases statistics** | Displays statistics for databases. **Read all data types** | Reads all data types from the server (including arrays). **Read table keys with columns** | Enable reading table constraints during the column reading stage to ensure accurate recognition of keys. Note that this setting may decrease metadata loading performance. **Replace legacy timezone** | Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like **Europe/Kyiv** or **Asia/Calcutta**. Only these two timezones are affected. **Show`$$` quote as** | Displays `$$` quotes as code blocks or strings. **Show`$tagName$` quote as** | Displays `$tagName$` quotes as code blocks or strings. ### Driver properties tab¶ Use the **Driver properties** tab to fine-tune how the JDBC driver connects to Aurora DSQL. ![](../images/database/aurora-dsql/aurora-dsql-connection-driver- properties.png) This tab exposes low-level JDBC parameters, such as timeouts, fetch behavior, binary transfer, and metadata handling. Info In most cases, the default values work well and don’t require changes. ## Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Aurora DSQL connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Aurora DSQL driver properties¶ The settings for Aurora DSQL **Driver properties** enable you to adjust the performance of the Aurora DSQL JDBC driver. These adjustments can influence the efficiency, compatibility, and features of your Aurora DSQL database. You can customize the Aurora DSQL driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Aurora DSQL database connections. Info For a comprehensive guide on these settings, refer to our [Driver manager](../Driver-Manager/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Aurora DSQL database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Aurora DSQL with DBeaver¶ DBeaver provides a host of features designed for Aurora DSQL databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ### Aurora DSQL database objects¶ DBeaver has extensive support for various Aurora DSQL metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Tables * Columns * Constraints * Dependencies * Rules * Policies * Views * Functions * Data types * Event Triggers * Extensions * Roles ### Additional features¶ Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Data Visualization | [ERD Guide](../ER-Diagrams/) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Azure-CosmosDB-for-NoSQL/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * Cosmos DB for NoSQL [ Cosmos DB for NoSQL ](./) Table of contents * Azure Cosmos DB for NoSQL specialty * Setting Up * Connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Azure Cosmos DB for NoSQL with DBeaver * Supported queries * Azure Cosmos DB for NoSQL database objects * Azure Cosmos DB for NoSQL features in DBeaver * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Azure Cosmos DB for NoSQL specialty * Setting Up * Connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Azure Cosmos DB for NoSQL with DBeaver * Supported queries * Azure Cosmos DB for NoSQL database objects * Azure Cosmos DB for NoSQL features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Azure # Cosmos DB for NoSQL Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide shows how to connect Azure Cosmos DB for NoSQL in DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Azure Cosmos DB for NoSQL` option to connect to the Azure Cosmos DB for NoSQL database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/cosmosdb/cosmosdb-for-nosql-driver.png) Info DBeaver can connect to the Azure Cosmos DB for NoSQL databases using the [Cloud Explorer](../AWS-Cloud-Explorer/). ## Azure Cosmos DB for NoSQL specialty¶ Azure Cosmos DB for NoSQL is a cloud database from Microsoft. It stores data as `JSON` documents and doesn’t require a fixed schema. It’s fast, can scale to handle large workloads, and lets you run SQL-like queries. For details, see Supported queries. It’s designed for global apps, with automatic replication and high availability. You can also set different consistency levels to balance speed and accuracy. For details, see the [official documentation](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/). Important In DBeaver, Azure Cosmos DB for NoSQL is read-only. ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies and Kubernetes for Azure Cosmos DB for NoSQL. ## Connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Azure Cosmos DB for NoSQL database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Azure Cosmos DB for NoSQL database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/cosmosdb/cosmosdb-for-nosql-connection-main.png) Field | Description ---|--- **Endpoint** | Enter the connection endpoint (URI) of your Azure Cosmos DB for NoSQL account. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) \- Account key (article coming soon) \- [Microsoft Entra ID for Cosmos DB for NoSQL](../Authentication-Microsoft- Entra-ID/) **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Azure Cosmos DB for NoSQL connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Secure Connection Configurations¶ DBeaver supports secure connections to your Azure Cosmos DB for NoSQL database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Azure Cosmos DB for NoSQL with DBeaver¶ DBeaver provides a host of features designed for Azure Cosmos DB for NoSQL databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## Supported queries¶ Azure Cosmos DB for NoSQL in DBeaver supports a subset of SQL-like syntax: * `SELECT`, `FROM`, `WHERE` * aliases (`SELECT * FROM c`) * `FROM` can use a fully qualified name, a container name, or an alias ## Azure Cosmos DB for NoSQL database objects¶ DBeaver lets you view and work with the main Azure Cosmos DB for NoSQL database objects: * Databases * Containers * Tables ## Azure Cosmos DB for NoSQL features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous features compatible with Azure CosmosDB, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Dashboards | [Dashboards](../Dashboards/) AI Assistant | [AI Assistant](../AI-Smart-Assistance/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-BigQuery/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * BigQuery [ BigQuery ](./) Table of contents * BigQuery specialty * Setting up * BigQuery connection settings * Connection details * Secure connection configurations * Secure Storage with Secret Providers * Powering BigQuery with DBeaver * BigQuery database objects * BigQuery additional features in DBeaver * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * BigQuery specialty * Setting up * BigQuery connection settings * Connection details * Secure connection configurations * Secure Storage with Secret Providers * Powering BigQuery with DBeaver * BigQuery database objects * BigQuery additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # BigQuery This documentation details the steps for configuring and utilizing BigQuery with DBeaver. The integration in DBeaver supports distinctive BigQuery functionalities, accommodating its serverless infrastructure, robust scalability, and compatibility with multi-cloud data analytics. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `BigQuery` option to connect to the BigQuery. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/bigquery/bigquery-drivers.png) ## BigQuery specialty¶ BigQuery is a fully managed, serverless data warehouse built for large-scale analytics. It’s optimized for fast SQL queries across massive datasets and supports both structured and semi-structured data. BigQuery separates storage and compute, and uses a distributed architecture to execute queries efficiently. Data is stored in a columnar format, and the system can auto- scale to handle multiple workloads in parallel. BigQuery also supports advanced data types like `GEOGRAPHY` for spatial analysis, `BIGNUMERIC` for high-precision calculations, and `INTERVAL` for time-based logic. You can customize schemas using views and automate workflows using stored procedures. For more on BigQuery features, see the [BigQuery docs](https://cloud.google.com/bigquery/docs/introduction) overview. Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, Proxies, and Kubernetes. ## BigQuery connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a BigQuery database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your BigQuery database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/bigquery/bigquery-connection-main.png) Field | Description ---|--- **Project** | Enter the project ID for the Google Cloud Project where the BigQuery service is located. **Additional project(s)** | Specify any additional project IDs if applicable. **Host** | Set the host URL to the BigQuery API endpoint. **Port** | Enter the port number for your BigQuery database. The default BigQuery port is `443`. **Query dialect** | Choose the SQL dialect used for query execution: **Standard** (recommended) or **Legacy** BigQuery SQL. **Enable session mode** | Enable this option to maintain state across queries. This is useful for temporary tables or variables. Requires a valid location to be set for the connection to support session mode. **Location** | Choose a regional location where the session should run (appears when **Enable session mode** is checked). **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Default credentials](../GCP-Credentials/#default-credentials) \- [Key file](../GCP-Credentials/#key-file) \- [Web browser / SSO](../GCP-Credentials/#web-browser) \- [OAuth (Pregenerated)](../GCP-Credentials/#oauth-pregenerated) \- [DBeaver profile authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your BigQuery connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Secure connection configurations¶ DBeaver supports secure connections to your BigQuery database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering BigQuery with DBeaver¶ DBeaver provides a host of features designed for BigQuery databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## BigQuery database objects¶ DBeaver lets you view and manipulate a range of BigQuery database objects, such as: * Schemas * Tables * Columns * Keys * Foreign keys * Indexes * References * Views * Procedures * ML Models ## BigQuery additional features in DBeaver¶ DBeaver provides additional features compatible with BigQuery, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Schema Management | [Schema Compare](../Schema-compare/) | [ERD Guide](../ER-Diagrams/) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) Query insights | [Result details](../Result-Details-Panel/) | [Disable metadata queries](../Data-Editor/#disable-metadata-queries) Dashboards | [Bytes Processed for Project](../Dashboards/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-CSV/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * CSV [ CSV ](./) Table of contents * Legacy CSV driver * CSV Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Structuring CSV files with a schema * Why use a DDL file * How to create a DDL file * Folder structure * Internal database * Additional features * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Legacy CSV driver * CSV Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Structuring CSV files with a schema * Why use a DDL file * How to create a DDL file * Folder structure * Internal database * Additional features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. File drivers # CSV This guide provides instructions on how to set up and use CSV files with DBeaver. The **CSV Pro** driver allows you to work with CSV data as if it were in a database. You can retrieve data and apply filters, sorting, and other operations, even combining data from multiple files. Important When using the **CSV Pro** driver, all connected CSV files are read-only. To make changes, you need to update the original files outside DBeaver. Before you start, you need to create a connection in DBeaver and select the **CSV Pro** driver. If you haven’t done this, see our [Database Connection](../Create-Connection/) article. ![](../images/database/csv/csv-drivers.png) You can open and work with CSV files stored in your [Cloud Storage](../Cloud- Storage/) directly in DBeaver. Double-click a file to create a temporary connection. Files opened during a session appear in the **File databases** folder in [Database Navigator](../Database-Navigator/). These temporary connections are removed when you close DBeaver. ## Legacy CSV driver¶ In the **Community Edition** , a legacy **CSV Basic** driver is available. It supports only simple operations. ## CSV Files driver connection settings¶ This section describes how to set up a connection using the **CSV Pro** driver. The connection settings page requires the following fields: ![](../images/database/csv/csv-connection-page.png) **Field** | **Description** ---|--- **Connect by (Path/URL)** | Choose whether to connect using a local host path or a URL. **File paths** | Specify the location of the CSV file(s). Choose an action: \- **Edit** : Modify an existing file or folder selection. \- **Add** : Add a new file or folder. \- **Remove** : Delete a selected file or folder. When **Editing** or **Adding** , choose from: \- **File** : Select a single file. \- **Folder** : Choose a directory containing multiple CSV files. For more details, see Folder structure section. \- **Remote** : Access a remote folder via [Cloud Storage](../Cloud-Storage/). This feature is available only in Ultimate and Team Editions. **Driver name** | This field will be auto-filled based on your selected driver type. **Driver settings** | If there are any specific driver settings, configure them here. Tip When using the **Folder** option, DBeaver scans the directory up to two levels deep for CSV files. For more information, see folder structure. If you select a folder, DBeaver organizes files in schemas based on their directory structure. ## Features and capabilities¶ ### Advanced SQL query capabilities¶ The **CSV Pro** driver supports the full range of SQL queries: * **Simple queries** (e.g., `SELECT * FROM table`): Data is read directly from the CSV file. * **Complex queries** (e.g., using `WHERE`, `JOIN`, `ORDER BY`, `GROUP BY`): When a complex query is executed for the first time, the driver imports the entire CSV file into an internal database to enable advanced SQL functions. Subsequent queries run faster because the data is already imported into internal database. ### Structuring CSV files with a schema¶ CSV files don’t include metadata about their structure, such as column names or data types. To enhance how DBeaver interprets these files, you can define a schema using a DDL (Data Definition Language) file. #### Why use a DDL file¶ A DDL file helps DBeaver interpret your data more accurately by defining: * Column names * Data types * Optional indexes for better performance #### How to create a DDL file¶ 1. Create a `.ddl` file with the same name as your CSV file, placing it in the same directory (e.g., `employees.csv` and `employees.csv.ddl`). 2. Write a schema using the `CREATE TABLE` statement: CREATE TABLE employees ( id INTEGER, name TEXT NOT NULL, age INTEGER, department TEXT ); CREATE INDEX idx_employees_id ON employees (id); Important If the DDL file contains errors, DBeaver will ignore it. You can still query the file, but column types will be inferred from the data. ### Folder structure¶ When working with a folder containing multiple CSV files, DBeaver organizes them as follows: Folder structure | Schema in DBeaver ---|--- Root files | `Default` schema Subfolder files | Schema named after the subfolder Files in deeper folders | Ignored If your folder looks like this: Data/ ├── employees.csv ├── sales.csv └── Reports/ └── monthly.csv └── yearly.csv DBeaver will create: * `Default` schema: `employees`, `sales` * `Reports` schema: `monthly`, `yearly` Tip To focus on specific files, consider selecting individual files or folders when configuring the connection. ### Internal database¶ When you execute a complex query (such as `WHERE`, `JOIN`, `GROUP BY`, or `ORDER BY`.), on an **CSV** file for the first time, the **CSV Pro** driver processes the data by importing it into a temporary internal SQLite database. By default, this internal database stores data temporarily on the disk during your session and is cleared when DBeaver restarts. To speed up queries on the same file in future sessions, you can specify the `internalDbFilePath` option in the **Driver properties** tab (e.g., `C:\User\database.db`) to reuse the processed data. ![](../images/database/csv/internal-database-settings.png) Info For more details on driver properties, see [File-based driver properties](../File-based-driver-properties/). ### Additional features¶ DBeaver provides additional features compatible with **CSV Pro** driver, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Data Visualization | [Visual Query Builder](../Visual-Query-Builder/) | [Charts](../Managing-Charts/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-CosmosDB/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * Cosmos DB [ Cosmos DB ](./) Table of contents * Setting Up * Secure Connection Configurations * Secure Storage with Secret Providers * Differences between Cosmos DB and MongoDB in DBeaver * Session Manager * Azure Connection * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * Secure Connection Configurations * Secure Storage with Secret Providers * Differences between Cosmos DB and MongoDB in DBeaver * Session Manager * Azure Connection 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Azure # Cosmos DB Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver offers extensive support for Cosmos DB, a globally distributed, multimodel database service provided by Microsoft Azure. Before you start, you must create a connection in DBeaver and select Cosmos DB. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. Cosmos DB is similar to MongoDB in many ways, and DBeaver's support for Cosmos DB includes collections browsing, data viewing, and SQL queries execution. For a detailed guide, refer to the [MongoDB article](../MongoDB/). ## Setting Up¶ Setting up Cosmos DB in DBeaver is also similar to setting up MongoDB. ### Secure Connection Configurations¶ DBeaver supports secure connections to your Cosmos DB database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Differences between Cosmos DB and MongoDB in DBeaver¶ ### Session Manager¶ Unlike MongoDB, Cosmos DB does not have a [Session Manager](../Session- Manager-Guide/) in DBeaver. This means that you would not be able to manage server sessions directly within DBeaver when using Cosmos DB. ### Azure Connection¶ Unique to Cosmos DB, DBeaver provides the option to connect through the [Cloud Explorer](../Cloud-Explorer/) feature, specifically for Azure. This feature allows you to browse and manage your Azure resources directly from DBeaver. You can view your Cosmos DB instances, along with other Azure resources, in a structured tree view. ![](../images/database/cosmosdb/cosmosdb-cloud-explorer.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Databricks/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * Databricks [ Databricks ](./) Table of contents * Databricks specialty * Setting up * Databricks connection settings * Connection details * Databricks driver properties * Secure connection configurations * Secure Storage with Secret Providers * Powering Databricks with DBeaver * Databricks database objects * Databricks features in DBeaver * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Databricks specialty * Setting up * Databricks connection settings * Connection details * Databricks driver properties * Secure connection configurations * Secure Storage with Secret Providers * Powering Databricks with DBeaver * Databricks database objects * Databricks features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Databricks # Databricks This guide provides instructions on how to set up and use Databricks with DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Databricks` option to connect to the Databricks database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/databricks/databricks-drivers.png) ## Databricks specialty¶ Databricks, based on Apache Spark, is a distributed computing system primarily used for machine learning and big data analytics. Its architecture is specially optimized for handling large-scale data processing and advanced analytics tasks. Databricks integrates with MLlib in Apache Spark, offering scalable algorithms and utilities for machine learning tasks. It also facilitates collaborative work through its notebooks, allowing teams to share code, visualizations, and insights effectively. For more detailed information and a comprehensive understanding of Databricks, please refer to the [official documentation](https://docs.databricks.com/aws/en/getting-started/). Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH and proxies for Databricks. ## Databricks connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Databricks database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Databricks database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/databricks/databricks-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Host/Instance** | If you are connecting via host or instance, enter the address of your Databricks database here. **Database** | Enter the name of the Databricks database you want to connect to. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [OAuth (Machine to Machine)](../Authentication-Databricks/#machine-to- machine) ![](../images/commercial.png) \- [OAuth (Machine to Machine)](../Authentication-Databricks/#user-to-machine) ![](../images/commercial.png) \- [Personal Access Token](../Authentication-Databricks/#personal-access- token) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with a Databricks database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Databricks driver properties¶ The settings for Databricks **Driver properties** enable you to adjust the performance of Databricks JDBC driver. These adjustments can influence the efficiency, compatibility, and features of your Databricks database. For a complete walkthrough on setting up Databricks JDBC driver properties, you can refer to the official [Databricks JDBC documentation](https://learn.microsoft.com/en- us/azure/databricks/_extras/documents/databricks-jdbc-driver-install-and- configuration-guide.pdf). These guides detail each driver's properties and how they can be used to optimize Databricks database connections. You can customize the Databricks driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Databricks database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### Secure connection configurations¶ DBeaver supports secure connections to your Databricks database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Databricks with DBeaver¶ DBeaver provides a host of features designed for Databricks databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### Databricks database objects¶ DBeaver lets you view and manipulate a wide range of Databricks database objects. DBeaver has extensive support for various Databricks metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Tables * Columns * Keys * Foreign keys * References * Views * Procedures ## Databricks features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous additional features compatible with Databricks, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Data Visualization | [ERD Guide](../ER-Diagrams/) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Files-MultiSource/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * Multi source [ Multi source ](./) Table of contents * Multi Source driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Multi Source driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. File drivers # Multi source Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide explains how to set up and use the **Multi Source** driver in DBeaver. This driver allows you to work with multiple files of different formats within a single connection, including: * [CSV](../Database-driver-CSV/) * [JSON](../Database-driver-JSON/) * [Parquet](../Database-driver-Parquet/) * [XML](../Database-driver-XML/) * [XLSX](../Database-driver-XLSX/) You can query data from different sources simultaneously, apply filters and sorting, and even join data across files. Important When using the **Multi Source** driver, all connected files are read-only. To make changes, update the original files outside DBeaver. Before you start, create a connection in DBeaver and select the **Multi Source** driver. If you haven’t done this, see our [Database Connection](../Create-Connection/) article. ![](../images/database/multi-source/multi-source-drivers.png) You can open and work with files stored in your [Cloud Storage](../Cloud- Storage/) directly in DBeaver. Double-click a file to create a temporary connection. Files opened during a session appear in the **File databases** folder in [Database Navigator](../Database-Navigator/). These temporary connections are removed when you close DBeaver. ## Multi Source driver connection settings¶ This section describes how to set up a connection using the **Multi Source** driver. The connection settings page requires the following fields: ![](../images/database/multi-source/multi-source-connection-page.png) **Field** | **Description** ---|--- **Connect by (Path/URL)** | Choose whether to connect using a local host path or a URL. **File paths** | Specify the location of the Multi Source file(s). Choose an action: \- **Edit** : Modify an existing file or folder selection. \- **Add** : Add a new file or folder. \- **Remove** : Delete a selected file or folder. When **Editing** or **Adding** , choose from: \- **File** : Select a single file. \- **Folder** : Choose a directory containing multiple files. For more details, see Folder structure section. \- **Remote** : Access a remote folder via [Cloud Storage](../Cloud-Storage/). This feature is available only in Ultimate and Team Editions. **Driver name** | This field will be auto-filled based on your selected driver type. **Driver settings** | If there are any specific driver settings, configure them here. Tip When using the **Folder** option, DBeaver scans the directory up to two levels deep for supported files. If the folder contains multiple files, DBeaver organizes them into schemas based on their directory structure. For more information, see folder structure. ## Features and capabilities¶ ### Advanced SQL query capabilities¶ The **Multi Source** driver supports the full range of SQL queries: * **Simple queries** (e.g., `SELECT * FROM table`): Data is read directly from the files. * **Complex queries** (e.g., using `WHERE`, `JOIN`, `ORDER BY`, `GROUP BY`): When a complex query is executed for the first time, the driver imports the data from all selected files into an internal database to enable advanced SQL functions. Subsequent queries run faster because the data is already imported into an internal database. Note If you join data from different files, they must be opened in the same connection. ### Folder structure¶ When working with multiple files and folders, DBeaver organizes them as follows: Location | Schema in DBeaver ---|--- Root files | `Default` schema Subfolder files | Schema named after the subfolder Files in deeper folders | Ignored If your folder structure looks like this: Data/ ├── employees.csv ├── sales.json └── Reports/ ├── monthly.xml ├── yearly.parquet └── summary.xlsx DBeaver will create: * `Default` schema: `employees`, `sales` * `Reports` schema: `monthly`, `yearly`, `summary` Tip To focus on specific files, consider selecting individual files or folders when configuring the connection. ### Internal database¶ When you execute a complex query (such as `WHERE`, `JOIN`, `GROUP BY`, or `ORDER BY`.) on multiple files for the first time, the **Multi Source** driver processes the data by importing it into a temporary internal SQLite database. By default, this internal database stores data temporarily on the disk during your session and is cleared when DBeaver restarts. To speed up queries on the same files in future sessions, you can specify the `internalDbFilePath` option in the **Driver properties** tab (e.g., `C:\User\database.db`) to reuse the processed data. ![](../images/database/multi-source/internal-database-settings.png) Info For more details on driver properties, see [File-based driver properties](../File-based-driver-properties/). ### Additional features¶ DBeaver provides additional features compatible with **Multi Source** driver, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Data Visualization | [Visual Query Builder](../Visual-Query-Builder/) | [Charts](../Managing-Charts/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Firestore/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * Firestore [ Firestore ](./) Table of contents * Firestore specialty * Setting Up * Firestore connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Firestore with DBeaver * Working with Collections and Subcollections * Creating a Subcollection * Viewing Subcollections * Firestore features in DBeaver * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Firestore specialty * Setting Up * Firestore connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Firestore with DBeaver * Working with Collections and Subcollections * Creating a Subcollection * Viewing Subcollections * Firestore features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # Firestore Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use Firestore with DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Firestore` option to connect to the Firestore database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/firestore/firestore-drivers.png) Info DBeaver can connect to the Firestore databases using the [Cloud Explorer](../AWS-Cloud-Explorer/). ## Firestore specialty¶ Firestore is a flexible, scalable database for mobile, web, and server development from Firebase and Google Cloud Platform. Firestore is a NoSQL database that stores data in documents, which are organized into collections. Each document contains a set of key-value pairs and is identified by a unique identifier. Firestore's real-time data synchronization capabilities allow developers to build collaborative applications by enabling real-time updates to data across all connected clients. It supports offline data access, enabling applications to function seamlessly without an internet connection. Security and data validation are enforced through Firestore Security Rules, allowing developers to control access to documents and collections. Firestore is designed to scale automatically, handling large datasets with ease. It supports powerful query capabilities, allowing efficient data retrieval and filtering. For more details, refer to the official [Firestore documentation](https://cloud.google.com/firestore#documentation). ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, and Kubernetes. ## Firestore connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Firestore database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Firestore database. The connection settings page requires you to fill in specific fields to establish the initial connection. ![](../images/database/firestore/firestore-connection-main.png) Field | Description ---|--- **Project** | Choose the name of the Project you want to connect to. **Database** | Enter the name of the Firestore database you want to connect to. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) \- Google Cloud IAM (coming soon) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Firestore connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Secure Connection Configurations¶ DBeaver supports secure connections to your Firestore database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Firestore with DBeaver¶ DBeaver provides support for Firestore, focusing on facilitating the management of collections and subcollections. ## Working with Collections and Subcollections¶ Firestore organizes data into collections, which are containers for documents. Additionally, collections can contain subcollections, enabling a hierarchical structure for data organization. The process for managing Firestore collections mirrors the familiar experience of creating and handling objects in the [Database Navigator](../Database- Navigator/). ### Creating a Subcollection¶ To work with Firestore subcollections, follow these instructions: 1. Open the collection in [Data Editor](../Data-Editor/) and click the Subcollections button ![](../images/ug/subcollections-button.png) located in the [right sidebar](../Data-Editor/#right-sidebar) to access the management interface for Firestore's subcollections. 2. In the Subcollections window, you will find options to create new subcollections, delete the existing ones, or refresh the list to view the latest data. 3. To add a Subcollection, click the **Create collection** button ![](../images/plus-button.png). You will be prompted to enter a name for the new collection. 4. After setting up the subcollection's name, it is ready to be filled with data, structured according to your application's requirements. ### Viewing Subcollections¶ To view subcollections: 1. Navigate to the collection in Data Editor. 2. Select the object (collection) for which you wish to view the subcollections. 3. Click the Subcollections button ![](../images/ug/subcollections-button.png). ![](../images/database/firestore/subcollection-button-location.png) Tip To view data in `JSON` format, click the corresponding button in the [left sidebar](../Data-Editor/#left-sidebar). ## Firestore features in DBeaver¶ In addition to facilitating the management of collections and subcollections, DBeaver's integration with Firestore includes a range of features designed to enhance the user experience and efficiency when working with Firestore databases. Here are some of the key features: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Google-Cloud-Spanner/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * Spanner [ Spanner ](./) Table of contents * Google Spanner specialty * Setting Up * Google Spanner connection settings * Connection details * Google Spanner driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Google Spanner with DBeaver * Google Spanner database objects * Google Spanner additional features in DBeaver * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Google Spanner specialty * Setting Up * Google Spanner connection settings * Connection details * Google Spanner driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Google Spanner with DBeaver * Google Spanner database objects * Google Spanner additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # Spanner Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides step-by-step instructions on how to set up and manage Google Cloud Spanner databases using DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Google Cloud Spanner` option to connect to your database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/spanner/google-cloud-spanner-drivers.png) Tip You can connect to your databases using the [Cloud Explorer](../Cloud- Explorer/). ## Google Spanner specialty¶ Google Spanner is a distributed database system that combines features from both relational and NoSQL databases. It stands out for its large-scale capabilities, designed to manage extensive data across numerous nodes while maintaining high availability and global consistency. In Google Spanner, the metadata types resemble those in traditional relational databases, with tables, columns, schemas, and key constraints, including primary keys, foreign keys, and unique constraints. A significant aspect of Google Spanner is its synchronization mechanism for nodes. It uses atomic clocks and GPS receivers to power its TrueTime system, ensuring precise synchronization across all nodes. This advanced timekeeping infrastructure is crucial for maintaining external consistency in distributed transactions and offers a robust solution for strong consistency on a global scale. For a more comprehensive understanding of Google Spanner, please refer to the [official documentation](https://cloud.google.com/spanner/docs). Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, and Kubernetes. ## Google Spanner connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Google Spanner database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Google Spanner database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/spanner/google-cloud-spanner-connection-main.png) Field | Description ---|--- **Project** | Enter the project name of your Google Spanner database here. **Instance** | For a direct connection to a Google Spanner instance, use the format `project:region:instance`. Here, `project` refers to your Google Cloud project ID, `region` denotes the geographical location of your instance, and `instance` is the unique ID of your Google Cloud SQL instance. **Database** | Enter the name of the Google Spanner database you want to connect to. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Google Cloud IAM (Spanner)](../GCP-Credentials/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Google Spanner connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Google Spanner driver properties¶ The settings for Google Spanner **Driver properties** enable you to adjust the performance of the Google Spanner JDBC driver. These adjustments can influence the efficiency, compatibility, and features of your Google Spanner database. For a complete walkthrough on setting up Google Spanner JDBC driver properties, you can refer to the official [Google Spanner JDBC documentation](https://cloud.google.com/spanner/docs/use-oss-jdbc). You can customize the Google Spanner driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Google Spanner database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Google Spanner database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Google Spanner with DBeaver¶ DBeaver provides a host of features designed for Google Spanner databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ## Google Spanner database objects¶ DBeaver lets you view and manipulate a wide range of Google Spanner database objects. DBeaver has extensive support for various Google Spanner metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Tables * Columns * Keys * Foreign Keys * Indexes * References * Views * Procedures ## Google Spanner additional features in DBeaver¶ DBeaver provides additional features compatible with Google Spanner, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Data Visualization | [ERD Guide](../ER-Diagrams/) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Greenplum/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * Greenplum [ Greenplum ](./) Table of contents * Greenplum specialty * Setting Up * Greenplum connection settings * Connection details * Greenplum driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Greenplum with DBeaver * Greenplum database objects * Greenplum Features in DBeaver * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Greenplum specialty * Setting Up * Greenplum connection settings * Connection details * Greenplum driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Greenplum with DBeaver * Greenplum database objects * Greenplum Features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Greenplum This guide provides instructions on how to set up and use Greenplum with DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Greenplum` option to connect to the Greenplum database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/greeenplum/greenplum-drivers.png) ## Greenplum specialty¶ Greenplum is a highly scalable, multi-node relational database system, primarily used for data warehousing and analytics. A key characteristic of Greenplum is its columnar data storage capabilities, making it particularly effective for analytics and large-scale data processing. Built on PostgreSQL, it supports rich metadata structures, including tables, views, indexes, sequences, and various data types. Its setup in DBeaver mostly replicates the PostgreSQL driver configuration. Greenplum includes support for SQL triggers, stored procedures, and user-defined functions, enhancing its utility for complex data operations. It also provides robust data partitioning options and supports diverse storage models like row and column store, optimizing performance for a variety of workloads. For a more comprehensive understanding of Greenplum, please refer to the [official documentation](https://docs.vmware.com/en/VMware-Greenplum/index.html). ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, Kubernetes, SSL, and the setup of ODBC/JDBC drivers for Greenplum. ## Greenplum connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Greenplum database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Greenplum database. 1. The first page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/greeenplum/greenplum-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Greenplum database. **URL** | If you are connecting via URL, enter the URL of your Greenplum database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your Greenplum database here. **Database** | Enter the name of the Greenplum database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Port** | Enter the port number for your Greenplum database. The default Greenplum port is `5432`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [PostgreSQL Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) \- [PostgreSQL PgPass Authentication](../Authentication-PostgreSQL-Pgpass/) \- [PostgreSQL SSPI Authentication](../Authentication-PostgreSQL-SSPI/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Local Client** | Specify the local client, see our article about [Local client](../Local-Client-Configuration/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The second page of the connection settings offers additional options that allow you to customize your further connection to the Greenplum database. ![](../images/database/greeenplum/greenplum-connection-second-page.png) Field | Description ---|--- **Show template databases** | Displays template databases. This option is available when **Show all databases** is checked. **Show databases unavailable for connection** | Show databases not available for connection in database list. This option is available when **Show all databases** is checked. **Show databases statistics** | Displays statistics for databases. **Read all data types** | Reads all data types from the server (including arrays). **Read table keys with columns** | Enable reading table constraints during the column reading stage to ensure accurate recognition of keys. Note that this setting may decrease metadata loading performance. **Replace legacy timezone** | Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like **Europe/Kyiv** or **Asia/Calcutta**. Only these two timezones are affected. **Show`$$` quote as** | Displays `$$` quotes as code blocks or strings. **Show`$tagName$` quote as** | Displays `$tagName$` quotes as code blocks or strings. **Use prepared statements** | Uses prepared statements for SQL execution. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Greenplum connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Greenplum driver properties¶ The settings for Greenplum **Driver properties** enable you to adjust the performance of the Greenplum JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Greenplum database. For a complete walkthrough on setting up Greenplum JDBC and ODBC drivers properties, you can refer to the official [Greenplum JDBC documentation](https://docs.progress.com/bundle/datadirect-pivotal-greenplum- jdbc-60/page/Welcome-to-the-Progress-DataDirect-for-JDBC-for-Greenplum- Driver.html) and [Greenplum ODBC documentation](https://docs.progress.com/bundle/datadirect-connect- odbc-71/page/The-Greenplum-Wire-Protocol-Driver.html). These guides detail each driver's properties and how they can be used to optimize Greenplum database connections. You can customize the Greenplum driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Greenplum database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing Greenplum database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Greenplum database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Greenplum database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Greenplum with DBeaver¶ DBeaver provides a host of features designed for Greenplum databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## Greenplum database objects¶ DBeaver lets you view and manipulate a wide range of Greenplum database objects. DBeaver has extensive support for various Greenplum metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Data types * Tables * Columns * Constraints * Indexes * Dependencies * References * Partitions * Triggers * Rules * Policies * External Tables * Views * Functions * Sequences * Data types * Aggregate functions * Event triggers * Storage * Tablespaces * Roles * Administer * Jobs * Session Manager * Lock Manager ## Greenplum Features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous additional features compatible with Greenplum, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Lock Management | [Lock Manager](../Lock-Manager/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) | [Query Execution plan](../Query-Execution-Plan/) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-IBM-Db2/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * IBM Db2 [ IBM Db2 ](./) Table of contents * Setting Up * Db2 connection settings * Connection details * Trace Settings * Db2 driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Db2 with DBeaver * Db2 database objects * Db2 features in DBeaver * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * Db2 connection settings * Connection details * Trace Settings * Db2 driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Db2 with DBeaver * Db2 database objects * Db2 features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # IBM Db2 This guide provides instructions on how to set up and use IBM DB2 with DBeaver. Before you start, you must create a connection in DBeaver and select IBM DB2. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the IBM DB2 server using a specific driver, it supports all versions of IBM DB2, but the correct driver must be selected: use **Db2 for LUW (Old 8.x)** for versions below 8.x and **Db2 for LUW** for newer versions. DBeaver also supports various IBM DB2 databases such as **Db2 for IBM i** , and **Db2 for z/OS**. You must select the appropriate driver in the **Connect to a database** window for these databases. ![](../images/database/db2/db2-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for Db2. Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ### Db2 connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Db2 database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Db2 database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/db2/db2-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Db2 database. **URL** | If you are connecting via URL, enter the URL of your Db2 database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your Db2 database here. **Database** | Enter the name of the Db2 database you want to connect to. **Port** | Enter the port number for your Db2 database. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Kerberos Authentication](../Kerberos-Authentication/) (only supported with **Db2 for LUW** driver version 11) ![](../images/commercial.png) **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Db2 connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) #### Trace Settings¶ In DBeaver, the trace settings feature allows you to monitor and record database operations in a detailed manner. To enable this feature, check the **Enable trace** box. You will need to specify a file where the traced information will be stored and formatted into a readable format. The trace settings page allows you to configure various levels and settings to tailor the tracing process according to your preferences. ![](../images/database/db2/db2-trace-settings.png) Setting | Description ---|--- **Folder** /**File name** | Specify the directory and file name where the trace data will be stored. This file will contain detailed information about the operations performed in the database. **Append** | This option allows you to add information to an existing trace file, instead of creating a new file each time the trace is enabled. **Connection Calls** | Records calls related to database connections. **Result Set Calls** | Records calls pertaining to the result sets. **Connects** | Records information about database connects. **Result Set Metadata** | Records metadata information from the result sets. **Diagnostics** | Records diagnostic information about database operations. **XA Calls** | Records information on XA distributed transactions. **Statement Calls** | Records calls related to SQL statements. **Driver Configuration** | Records configuration details of the database driver. **DRDA Flows** | Records information on DRDA data flows. **Parameter Metadata** | Records metadata about SQL parameters. **SQL J** | Records information on SQL J operations. For more detailed information on these settings, please refer to the [IBM documentation](https://www.ibm.com/docs/en/db2/11.5?topic=tools-traces). ## Db2 driver properties¶ The settings for Db2 **Driver properties** enable you to adjust the performance of the Db2 JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Db2 database. For a complete walkthrough on setting up Db2 JDBC and ODBC drivers properties, you can refer to the official [Db2 JDBC documentation](https://www.ibm.com/docs/en/db2/11.5?topic=SSEPGG_11.5.0/com.ibm.db2.luw.apdv.java.doc/src/tpc/imjcc_r0052607.htm) and [Db2 ODBC documentation](https://www.ibm.com/docs/en/db2/11.5?topic=odbc- cliodbc-configuration-keywords). These guides detail each driver's properties and how they can be used to optimize Db2 database connections. You can customize the Db2 driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Db2 database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing Db2 database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Db2 database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Db2 database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **SSL** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Db2 with DBeaver¶ DBeaver provides a host of features designed for Db2 databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ### Db2 database objects¶ DBeaver lets you view and manipulate a wide range of Db2 database objects. DBeaver has extensive support for various Db2 metadata types, allowing you to interact with a wide variety of database objects, such as: * Schemas * Tables * Columns * Unique Constraints * Foreign Keys * Indexes * References * Check Constraints * Partitions * Periods * Triggers * Columns Masks * Views * MQTs * Indexes * Sequences * Aliases * Nicknames * Triggers * XML Schemas * Application Objects * Functions * Modules * Packages * Procedures * User Defined Types * Federation * Wrappers * Remote Servers * User Mappings * Global metadata * Types * Variables * XML Strings * Storage * Bufferpools * Tablespaces * Storage Groups * Administer * Session Manager * Security * Roles * Groups * Users ### Db2 features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for DB2. Beyond regular SQL operations, DBeaver provides a range of Db2-specific capabilities, such as: Category | Feature ---|--- Schemas | Unique Constraints | Periods | Column Masks Views | MQTs Federation | Wrappers | Remote Servers Global Metadata | XML Strings Storage | Bufferpools | Tablespaces Security | Roles | Groups Additional features compatible with Db2, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Lock Management | [Lock Manager](../Lock-Manager/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) Query insights | [Disable metadata queries](../Data-Editor/#disable-metadata-queries) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-JSON/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * JSON [ JSON ](./) Table of contents * JSON Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * JSON Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. File drivers # JSON Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use JSON files with DBeaver. The **JSON** driver supports standard JSON files and allows you to work with JSON data as if it were in a database. You can retrieve data and apply filters, sorting, and other operations, even combining data from multiple files. Important When using the **JSON** driver, all connected JSON files are read-only. To make changes, you need to update the original files outside DBeaver. Before you start, you need to create a connection in DBeaver and select the appropriate **JSON** driver. If you haven’t done this, see our [Database Connection](../Create-Connection/) article. ![](../images/database/json/json-driver.png) You can open and work with JSON files stored in your [Cloud Storage](../Cloud- Storage/) directly in DBeaver. Double-click a file to create a temporary connection. Files opened during a session appear in the **File databases** folder in [Database Navigator](../Database-Navigator/). These temporary connections are removed when you close DBeaver. ## JSON Files driver connection settings¶ This section describes how to set up a connection using the **JSON** driver. The connection settings page requires the following fields: ![](../images/database/json/json-connection-page.png) **Field** | **Description** ---|--- **Connect by (Path/URL)** | Choose whether to connect using a local host path or a URL. **File paths** | Specify the location of the JSON file(s). Choose an action: \- **Edit** : Modify an existing file or folder selection. \- **Add** : Add a new file or folder. \- **Remove** : Delete a selected file or folder. When **Editing** or **Adding** , choose from: \- **File** : Select a single file. \- **Folder** : Choose a directory containing multiple JSON files. For more details, see Folder structure section. \- **Remote** : Access a remote folder via [Cloud Storage](../Cloud-Storage/). This feature is available only in Ultimate and Team Editions. **Driver name** | This field will be auto-filled based on your selected driver type. **Driver settings** | If there are any specific driver settings, configure them here. Tip When using the **Folder** option, DBeaver scans the directory up to two levels deep for JSON files. For more information, see folder structure. If you select a folder, DBeaver organizes files in schemas based on their directory structure. ## Features and capabilities¶ ### Advanced SQL query capabilities¶ The **JSON** driver supports the full range of SQL queries: * **Simple queries** (e.g., `SELECT * FROM table`): Data is read directly from the JSON file. * **Complex queries** (e.g., using `WHERE`, `JOIN`, `ORDER BY`, `GROUP BY`): When a complex query is executed for the first time, the driver imports the entire JSON file into an internal database to enable advanced SQL functions. Subsequent queries run faster because the data is already imported into an internal database. ### Folder structure¶ When working with a folder containing multiple JSON files, DBeaver organizes them as follows: Folder structure | Schema in DBeaver ---|--- Root files | `Default` schema Subfolder files | Schema named after the subfolder Files in deeper folders | Ignored If your folder looks like this: Data/ ├── employees.json ├── sales.json └── Reports/ └── monthly.json └── yearly.json DBeaver will create: * `Default` schema: `employees`, `sales` * `Reports` schema: `monthly`, `yearly` Tip To focus on specific files, consider selecting individual files or folders when configuring the connection. ### Internal database¶ When you execute a complex query (such as `WHERE`, `JOIN`, `GROUP BY`, or `ORDER BY`.), on a **JSON** file for the first time, the **JSON** driver processes the data by importing it into a temporary internal SQLite database. By default, this internal database stores data temporarily on the disk during your session and is cleared when DBeaver restarts. To speed up queries on the same file in future sessions, you can specify the `internalDbFilePath` option in the **Driver properties** tab (e.g., `C:\User\database.db`) to reuse the processed data. ![](../images/database/json/internal-database-settings.png) Info For more details on driver properties, see [File-based driver properties](../File-based-driver-properties/). ### Additional features¶ DBeaver provides additional features compatible with **JSON** driver, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Data Visualization | [Visual Query Builder](../Visual-Query-Builder/) | [Charts](../Managing-Charts/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-MariaDB/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * MariaDB [ MariaDB ](./) Table of contents * Setting Up * MariaDB connection settings * Connection details * MariaDB driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering MariaDB with DBeaver * MariaDB database objects * MariaDB features in DBeaver * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * MariaDB connection settings * Connection details * MariaDB driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering MariaDB with DBeaver * MariaDB database objects * MariaDB features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # MariaDB This guide provides instructions on how to set up and use MariaDB with DBeaver. DBeaver provides specialized features like support for unique data types including MariaDB Enumerations and Sets, as well as a variety of storage engines such as InnoDB and MyISAM. Before you start, you must create a connection in DBeaver and select MariaDB. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the MariaDB server using a specific driver, it supports all versions of MariaDB. ![](../images/database/mariadb/mariadb-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for MariaDB. ### MariaDB connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a MariaDB database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your MariaDB database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/mariadb/mariadb-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your MariaDB database. **URL** | If you are connecting via URL, enter the URL of your MariaDB database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your MariaDB database here. **Database** | Enter the name of the MariaDB database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). If not enabled, only the database from the connection is shown. **Port** | Enter the port number for your MariaDB database. The default MariaDB port is `3306`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [AWS RDS IAM Authentication](../AWS-Credentials/) ![](../images/commercial.png) \- [Azure AD Authentication for MySQL](../Authentication-Microsoft-Entra-ID/) ![](../images/commercial.png) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) \- [Two-factor Authentication](../Authentication-MySQL-Two-factor/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Local Client** | Specify the local client. **Server Time Zone** | This setting is responsible for determining the time zone used by the MariaDB server. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with MariaDB database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### MariaDB driver properties¶ The settings for MariaDB **Driver properties** enable you to adjust the performance of the MariaDB JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your MariaDB database. For a complete walkthrough on setting up MariaDB JDBC and ODBC drivers properties, you can refer to the official [MariaDB JDBC documentation](https://dev.MariaDB.com/doc/connector-j/8.1/en/) and [MariaDB ODBC documentation](https://dev.MariaDB.com/doc/connector-odbc/en/). These guides detail each driver's properties and how they can be used to optimize MariaDB database connections. You can customize the MariaDB driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your MariaDB database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing MariaDB database connections via ODBC/JDBC drivers. This functionality enables you to connect to your MariaDB database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. This process is similar across most databases that support ODBC/JDBC drivers. For a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver, you can refer to our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your MariaDB database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering MariaDB with DBeaver¶ DBeaver provides a host of features designed for MariaDB databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### MariaDB database objects¶ DBeaver lets you view and manipulate a wide range of MariaDB database objects. DBeaver has extensive support for various MariaDB metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Tables * Columns * Constraints * Foreign Keys * References * Triggers * Indexes * Partitions * Views * Procedures * Packages * Events * Users * Administer * Session Manager ### MariaDB features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for MariaDB. Beyond regular SQL operations, DBeaver provides a range of MariaDB-specific capabilities, such as: Category | Feature ---|--- Data Types | MariaDB Enumerations and Sets Security | MariaDB User Management Storage Engines | InnoDB, MyISAM, MRG_MyISAM, Archive, Blackhole, CSV, Memory, Performance_schema Database Management | MariaDB Events | MariaDB Stored Procedures Additional features compatible with MariaDB, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare ](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Microsoft-SQL-Server-on-Google-Cloud/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * Cloud SQL for SQL Server [ Cloud SQL for SQL Server ](./) Table of contents * Feature Highlights * Setting Up * Google Cloud SQL Server connection settings * Connection details * Driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Google Cloud SQL Server with DBeaver * Google Cloud SQL Server database objects * Google Cloud SQL Server additional features in DBeaver * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Feature Highlights * Setting Up * Google Cloud SQL Server connection settings * Connection details * Driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Google Cloud SQL Server with DBeaver * Google Cloud SQL Server database objects * Google Cloud SQL Server additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # Cloud SQL for SQL Server Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Google Cloud SQL for SQL Server is a managed database service provided by [Google Cloud](https://cloud.google.com/sql/sqlserver?hl=en), offering the robust capabilities of Google Cloud SQL Server with the added benefits of cloud hosting. This guide is designed to assist in the setup and management of Google Cloud SQL for SQL Server databases using DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `CloudSQL - SQL Server` option to connect to the Google Cloud SQL service. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/gcp_sqlserver/gcp-sql-server-drivers.png) Tip You can connect to your databases using the [Cloud Explorer](../Cloud- Explorer/). ## Feature Highlights¶ DBeaver extends beyond standard SQL tasks, offering a suite of SQL Server- specific features. These capabilities enhance the functionality and management of Google Cloud SQL Server databases, catering to specific needs and advanced use cases. * **Data Structure** : DBeaver provides extensive support for SQL Server's data structures, ensuring comprehensive management and interaction capabilities. This includes: * **SQL Server Tables & Views**: Facilitating advanced data representation and querying capabilities. * **SQL Server Procedures** : Supporting the creation, modification, and management of stored procedures for efficient data handling. * **SQL Server Sequences** : Enabling the creation and management of sequences for generating unique numbers. * **SQL Server Synonyms** : Offering the ability to use synonyms for database objects, simplifying SQL queries and enhancing data accessibility. * **SQL Server External Tables** : Supporting the integration of external data sources, allowing for extended data management beyond traditional database boundaries. * **Job Management** : DBeaver extends its functionalities to job management in SQL Server databases. This includes support for Agent Jobs, empowering users to schedule and automate various tasks, enhancing the efficiency of database operations and maintenance. ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for Google Cloud SQL Server. Note The connection process in DBeaver utilizes the standard SQL Server driver, tailored to interact with the Google Cloud SQL for SQL Server service, highlighting its cloud-based characteristics. ## Google Cloud SQL Server connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Google Cloud SQL Server database using DBeaver. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/gcp_sqlserver/gcp-sql-server-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Google Cloud SQL Server database. **URL** | If you are connecting via URL, enter the URL of your Google Cloud SQL Server database here. This field is hidden if you are connecting via the host. **Host/Instance** | For a direct connection to a Google Cloud SQL instance, use the format `project:region:instance`. Here, `project` refers to your Google Cloud project ID, `region` denotes the geographical location of your instance, and `instance` is the unique ID of your Google Cloud SQL instance. **Database/Schema** | Enter the name of the Google Cloud SQL Server database you want to connect to. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Google Cloud IAM](../GCP-Credentials/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Show All Schemas** | Shows all database schemas. If disabled shows only non-empty schemas. **Trust Server Certificate** | If `true`, the Google Cloud SQL Server SSL certificate is automatically trusted when the communication layer is encrypted using SSL. If `false`, the Microsoft JDBC Driver for SQL Server validates the server SSL certificate. If the server certificate validation fails, the driver raises an error and terminates the connection. To configure certificate settings in DBeaver, refer to our detailed article on [Truststore](../Managing-Truststore-Settings/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Google Cloud SQL Server database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Driver properties¶ While managing Google Cloud SQL Server databases hosted on Google Cloud with DBeaver, it's important to understand that the underlying driver is the standard SQL Server JDBC and ODBC driver. The settings for Google Cloud SQL Server **Driver properties** enable you to adjust the performance of the SQL Server JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Google Cloud SQL Server database. For a complete walkthrough on setting up SQL Server JDBC and ODBC drivers properties, you can refer to the official [SQL Server JDBC documentation](https://learn.microsoft.com/en-us/sql/connect/jdbc/microsoft- jdbc-driver-for-sql-server?view=sql-server-ver16#documentation) and [SQL Server ODBC documentation](https://learn.microsoft.com/en- us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server?view=sql-server- ver16#documentation). These guides detail each driver's properties and how they can be used to optimize Google Cloud SQL Server database connections. You can customize the SQL Server driver in DBeaver via the **Edit Driver** window, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This window offers a range of settings that can influence your Google Cloud SQL Server database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing Google Cloud SQL Server database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Google Cloud SQL Server database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Google Cloud SQL Server database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Google Cloud SQL Server with DBeaver¶ DBeaver provides a host of features designed for Google Cloud SQL Server databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## Google Cloud SQL Server database objects¶ DBeaver lets you view and manipulate a wide range of Google Cloud SQL Server database objects. DBeaver has extensive support for various SQL Server metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Tables * External Tables * Views * Columns * Triggers * External Properties * Indexes * Procedures * Sequences * Synonyms * Triggers * Data Types * Database triggers * Security * Logins * Administer * Sessions * Agent * Jobs ## Google Cloud SQL Server additional features in DBeaver¶ DBeaver provides additional features compatible with Google Cloud SQL Server, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) | [Query Execution plan](../Query-Execution-Plan/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Microsoft-SQL-Server/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * Microsoft SQL Server [ Microsoft SQL Server ](./) Table of contents * Setting Up * SQL Server connection settings * Connection details * SQL Server driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering SQL Server with DBeaver * SQL Server database objects * SQL Server features in DBeaver * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * SQL Server connection settings * Connection details * SQL Server driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering SQL Server with DBeaver * SQL Server database objects * SQL Server features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Microsoft SQL Server This guide provides instructions on how to set up and use SQL Server with DBeaver. Before you start, you must create a connection in DBeaver and select SQL Server. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the SQL Server using a specific driver, it supports all versions of SQL Server, but the correct driver must be selected: use **SQL Server (Old driver, jTDS)** for versions below 2012 and **SQL Server** for newer versions. DBeaver also supports SQL Server extensions such as **Azure SQL Server** , **Babelfish via TDS** and **Google Cloud Platform SQL Server**. You must select the appropriate driver in the **Connect to a database** window for these extensions. ![](../images/database/sqlserver/sql-server-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection, the configuration of secure connections, and the setup of ODBC/JDBC drivers for SQL Server. ### SQL Server connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a SQL Server database using DBeaver. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/sqlserver/sql-server-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your SQL Server database. **URL** | If you are connecting via URL, enter the URL of your SQL Server database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your SQL Server database here. **Database/Schema** | Enter the name of the SQL Server database you want to connect to. **Port** | Enter the port number for your SQL Server database. The default SQL Server port is `1433`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- SQL Server Authentication (coming soon) \- Active Directory - Integrated (coming soon) \- Active Directory - MFA (coming soon) \- Active Directory - MSI (coming soon) \- Active Directory - Password (coming soon) \- [Azure AD for SQL Server](../Authentication-Microsoft-Entra-ID/) ![](../images/commercial.png) \- Custom (coming soon) \- [DBeaver profile](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Kerberos](../Kerberos-Authentication/) ![](../images/commercial.png) \- NTLM (coming soon) \- Window Authentication (coming soon) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Show All Schemas** | Shows all database schemas. If disabled shows only non-empty schemas. **Trust Server Certificate** | If `true`, the SQL Server SSL certificate is automatically trusted when the communication layer is encrypted using SSL. If `false`, the Microsoft JDBC Driver for SQL Server validates the server SSL certificate. If the server certificate validation fails, the driver raises an error and terminates the connection. To configure certificate settings in DBeaver, refer to our detailed article on [Truststore](../Managing-Truststore-Settings/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with SQL Server database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### SQL Server driver properties¶ The settings for SQL Server **Driver properties** enable you to adjust the performance of the SQL Server JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your SQL Server database. For a complete walkthrough on setting up SQL Server JDBC and ODBC drivers properties, you can refer to the official [SQL Server JDBC documentation](https://learn.microsoft.com/en-us/sql/connect/jdbc/microsoft- jdbc-driver-for-sql-server?view=sql-server-ver16#documentation) and [SQL Server ODBC documentation](https://learn.microsoft.com/en- us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server?view=sql-server- ver16#documentation). These guides detail each driver's properties and how they can be used to optimize SQL Server database connections. You can customize the SQL Server driver in DBeaver via the **Edit Driver** window, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This window offers a range of settings that can influence your SQL Server database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing SQL Server database connections via ODBC/JDBC drivers. This functionality enables you to connect to your SQL Server database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your SQL Server database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering SQL Server with DBeaver¶ DBeaver provides a host of features designed for SQL Server databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ### SQL Server database objects¶ DBeaver lets you view and manipulate a wide range of SQL Server database objects. DBeaver has extensive support for various SQL Server metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Tables * External Tables * Views * Columns Triggers * External Properties * Indexes * Procedures * Sequences * Synonyms * Triggers * Data Types * Database triggers * Security * Logins * Administer * Sessions * Agent * Jobs ### SQL Server features in DBeaver¶ DBeaver includes many features that go beyond basic SQL operations like querying, updating, inserting, and deleting data. It also includes numerous unique features specifically for SQL Server. Beyond regular SQL operations, DBeaver offers a range of SQL Server-specific capabilities, such as: Category | Feature ---|--- Data Structure | SQL Server Tables & Views | SQL Server Procedures | SQL Server Sequences | SQL Server Synonyms | SQL Server External Tables Job Management | Agent Jobs Additional features compatible with SQL Server, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-MySQL-on-Google-Cloud/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * Cloud SQL for MySQL [ Cloud SQL for MySQL ](./) Table of contents * Feature highlights * Setting Up * Google Cloud MySQL connection settings * Connection details * Driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Google Cloud MySQL with DBeaver * Google Cloud MySQL database objects * MySQL additional features in DBeaver * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Feature highlights * Setting Up * Google Cloud MySQL connection settings * Connection details * Driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Google Cloud MySQL with DBeaver * Google Cloud MySQL database objects * MySQL additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # Cloud SQL for MySQL Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Google Cloud SQL for MySQL is a managed database service provided by [Google Cloud](https://cloud.google.com/sql/mysql?hl=en), offering the robust capabilities of MySQL with the added benefits of cloud hosting. This guide is designed to assist in the setup and management of Google Cloud SQL for MySQL databases using DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `CloudSQL - MySQL` option to connect to the Google Cloud SQL service. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create- Connection/) article for guidance. ![](../images/database/gcp_mysql/gcp-mysql-drivers.png) Tip You can connect to your databases using the [Cloud Explorer](../Cloud- Explorer/). ## Feature highlights¶ DBeaver extends beyond standard SQL tasks, offering a suite of MySQL-specific features. These capabilities enhance the functionality and management of Google Cloud MySQL databases, catering to specific needs and advanced use cases. * **Data Types** : DBeaver fully supports MySQL-specific data types such as Enumerations and Sets. This enables precise data structuring and validation directly within the interface. * **Security Management** : An integral part of managing databases is user security. DBeaver includes comprehensive tools for MySQL User Management, allowing for detailed control over user permissions and roles. * **Storage Engines** : Understanding and choosing the right storage engine is crucial for database performance. DBeaver supports various MySQL storage engines, including InnoDB, MyISAM, and specialized engines like MRG_MyISAM, Archive, Blackhole, CSV, Memory, and Performance_schema. * **Database Management Tools** : DBeaver provides advanced database management features specific to MySQL. This includes the management of MySQL Events and Stored Procedures, allowing for automation and efficient management of routine database tasks. ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for Google Cloud MySQL. Note The connection process in DBeaver utilizes the standard MySQL driver, tailored to interact with the Google Cloud SQL for MySQL service, highlighting its cloud-based characteristics. ### Google Cloud MySQL connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Google Cloud MySQL database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Google Cloud MySQL database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/gcp_mysql/gcp-mysql-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Google Cloud MySQL database. **URL** | If you are connecting via URL, enter the URL of your Google Cloud MySQL database here. This field is disabled if you're connecting via the host. **Host/Instance** | For a direct connection to a Google Cloud SQL instance, use the format `project:region:instance`. Here, `project` refers to your Google Cloud project ID, `region` denotes the geographical location of your instance, and `instance` is the unique ID of your Google Cloud SQL instance. **Database** | Enter the name of the Google Cloud MySQL database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). If not enabled, only the database from the connection is shown. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Google Cloud IAM](../GCP-Credentials/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Local Client** | Specify the local client, see our article about [local client configuration](../Local-Client-Configuration/). **Server Time Zone** | This setting is responsible for determining the time zone used by the Google Cloud MySQL server. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Google Cloud MySQL database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Driver properties¶ While managing MySQL databases hosted on Google Cloud with DBeaver, it's important to understand that the underlying driver is the standard MySQL JDBC and ODBC driver. The settings for Google Cloud MySQL **Driver properties** enable you to adjust the performance of the MySQL JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Google Cloud MySQL database. For a complete walkthrough on setting up MySQL JDBC and ODBC drivers properties, you can refer to the official [MySQL JDBC documentation](https://dev.mysql.com/doc/connector-j/8.1/en/) and [MySQL ODBC documentation](https://dev.mysql.com/doc/connector-odbc/en/). These guides detail each driver's properties and how they can be used to optimize Google Cloud MySQL database connections. You can customize the MySQL driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Google Cloud MySQL database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing Google Cloud MySQL database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Google Cloud MySQL database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. This process is similar across most databases that support ODBC/JDBC drivers. For a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver, you can refer to our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your Google Cloud MySQL database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Google Cloud MySQL with DBeaver¶ DBeaver offers an array of features specifically tailored for MySQL databases, including those hosted on Google Cloud. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### Google Cloud MySQL database objects¶ DBeaver lets you view and manipulate a wide range of database objects. DBeaver has extensive support for various MySQL metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Tables * Columns * Constraints * Indexes * Foreign Keys * References * Triggers * Views * Indexes * Procedures * Triggers * Events * Users * Administer * Session Manager ## MySQL additional features in DBeaver¶ DBeaver provides additional features compatible with Google Cloud MySQL, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare ](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) | [Query Execution plan](../Query-Execution-Plan/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-MySQL/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * MySQL [ MySQL ](./) Table of contents * Setting Up * MySQL connection settings * Connection details * MySQL driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering MySQL with DBeaver * MySQL database objects * MySQL Features in DBeaver * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * MySQL connection settings * Connection details * MySQL driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering MySQL with DBeaver * MySQL database objects * MySQL Features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. MySQL # MySQL This guide provides instructions on how to set up and use MySQL with DBeaver. Before you start, you must create a connection in DBeaver and select MySQL. If you have not done this, please refer to our [Database Connection](../Create- Connection/) article. DBeaver interacts with the MySQL server using a specific driver. It supports all versions of MySQL, but the correct driver must be selected: use MySQL (old) for versions 4.x and earlier, MySQL 5 for 5.x versions, and MySQL for version 8 and later. DBeaver also supports MySQL extensions such as NDB Cluster, OceanBase, and TiDB. For Google Cloud SQL, there is a dedicated Google Cloud SQL (MySQL) driver that supports MySQL version 8 and later. You must select the appropriate driver in the **Connect to a database** window for these extensions. ![](../images/database/mysql/mysql-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for MySQL. ### MySQL connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a MySQL database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your MySQL database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/mysql/mysql-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your MySQL database. **URL** | If you are connecting via URL, enter the URL of your MySQL database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your MySQL database here. **Database** | Enter the name of the MySQL database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). If not enabled, only the database from the connection is shown. **Port** | Enter the port number for your MySQL database. The default MySQL port is `3306`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [AWS RDS IAM Authentication](../AWS-Credentials/) ![](../images/commercial.png) \- [Azure AD Authentication for MySQL](../Authentication-Microsoft-Entra-ID/) ![](../images/commercial.png) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [MySQL Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) \- [Two-factor Authentication](../Authentication-MySQL-Two-factor/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Local Client** | Specify the local client, see our article about [local client configuration](../Local-Client-Configuration/). **Server Time Zone** | This setting is responsible for determining the time zone used by the MySQL server. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with MySQL database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### MySQL driver properties¶ The settings for MySQL **Driver properties** enable you to adjust the performance of the MySQL JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your MySQL database. For a complete walkthrough on setting up MySQL JDBC and ODBC drivers properties, you can refer to the official [MySQL JDBC documentation](https://dev.mysql.com/doc/connector-j/8.1/en/) and [MySQL ODBC documentation](https://dev.mysql.com/doc/connector-odbc/en/). These guides detail each driver's properties and how they can be used to optimize MySQL database connections. You can customize the MySQL driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your MySQL database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing MySQL database connections via ODBC/JDBC drivers. This functionality enables you to connect to your MySQL database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. This process is similar across most databases that support ODBC/JDBC drivers. For a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver, you can refer to our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your MySQL database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering MySQL with DBeaver¶ DBeaver provides a host of features designed for MySQL databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### MySQL database objects¶ DBeaver lets you view and manipulate a wide range of MySQL database objects. DBeaver has extensive support for various MySQL metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Tables * Columns * Constraints * Indexes * Foreign Keys * References * Triggers * Views * Indexes * Procedures * Triggers * Events * Users * Administer * Session Manager ### MySQL Features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for MySQL. Beyond regular SQL operations, DBeaver provides a range of MySQL-specific capabilities, such as: Category | Feature ---|--- Data Types | MySQL Enumerations and Sets Security | MySQL User Management Storage Engines | InnoDB, MyISAM, MRG_MyISAM, Archive, Blackhole, CSV, Memory, Performance_schema Database Management | MySQL Events | MySQL Stored Procedures Additional features compatible with MySQL, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare ](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Neo4j/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * Neo4j [ Neo4j ](./) Table of contents * Neo4j specialty * Setting up * Neo4j connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Neo4j with DBeaver * Neo4j database objects * Neo4j features in DBeaver * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Neo4j specialty * Setting up * Neo4j connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Neo4j with DBeaver * Neo4j database objects * Neo4j features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Graph # Neo4j Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use Neo4j with DBeaver. First, you must start creating a connection in DBeaver and select Neo4j. If you haven’t done this yet, see our [Database Connection](../Create- Connection/) article. DBeaver connects to Neo4j using a dedicated JDBC driver. It supports all modern Neo4j versions. ![](../images/database/neo4j/neo4j-driver.png) ## Neo4j specialty¶ Neo4j is a graph database built for working with connected data. It stores data as **nodes** and **relationships** , not tables. This format is great for things like networks, hierarchies, and recommendations. Neo4j uses **Cypher** – a SQL-like language designed for graph patterns. It’s optimized for exploring relationships, not just rows. Info For more, see the [Neo4j documentation](https://neo4j.com/docs/). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, AWS SSM and Kubernetes. Tip When you connect to Neo4j for the first time, DBeaver will prompt you to download the driver. Click the value under the **Version** column to open a dropdown menu and choose the version you need. For more on changing or updating the version, see [how to update driver version](../FAQ/#how-to- update-driver-version). ## Neo4j connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Neo4j database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Neo4j database. The connection settings page requires you to fill in specific fields to establish the initial connection. ![](../images/database/neo4j/neo4j-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **URL** | If you are connecting via URL, enter the URL of your Neo4j database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your Neo4j database here. **Port** | Enter the port number for your Neo4j database. The default Neo4j port is `7687`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Neo4j database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Secure Connection Configurations¶ DBeaver supports secure connections to your Neo4j database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Neo4j with DBeaver¶ DBeaver provides the ability to view and manage databases. ## Neo4j database objects¶ DBeaver lets you view and work with Neo4j database objects. It supports key metadata types, so you can explore and manage: * Databases * Tables (Nodes) * Columns (Properties) * Constraints * Indexes * Foreign Keys (Relationships) * Data types ## Neo4j features in DBeaver¶ In addition, Neo4j includes a range of features designed to enhance the user experience and efficiency when working with Neo4j databases. Here are some of the key features: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Browsing collections | [JSON documents](../Working-with-XML-and-JSON/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Neptune/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * Neptune [ Neptune ](./) Table of contents * Neptune specialty * Setting up * Neptune connection settings * Connection details * Secure connection configurations * Secure Storage with Secret Providers * Powering Neptune with DBeaver * Neptune database objects * Neptune additional features in DBeaver * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Neptune specialty * Setting up * Neptune connection settings * Connection details * Secure connection configurations * Secure Storage with Secret Providers * Powering Neptune with DBeaver * Neptune database objects * Neptune additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. AWS # Neptune Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This documentation outlines the process of configuring and using AWS Neptune with DBeaver. To manage databases using AWS Neptune in DBeaver, establishing a connection is essential. This is done by selecting the `Neptune` option in the database connection settings of DBeaver. For those new to this process, our [Creating a Connection](../Create-Connection/) article provides detailed guidance. ![](../images/database/neptune/neptune-drivers.png) Info DBeaver can connect to the AWS Neptune databases using the [Cloud Explorer](../AWS-Cloud-Explorer/). ![](../images/ug/cloud-explorer/aws-cloud-services.png) ## Neptune specialty¶ AWS Neptune, as a graph database service, is specialized for use cases involving highly connected data, such as social networks, recommendation engines, fraud detection, and knowledge graphs. Unlike traditional relational databases, Neptune is optimized for storing and querying graph data models, including property graphs and RDF (Resource Description Framework) data. For more detailed information, refer to the [AWS Neptune database documentation](https://docs.aws.amazon.com/neptune/). Important In DBeaver, AWS Neptune is read-only. ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, Proxies, AWS SSM and Kubernetes. ## Neptune connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Neptune database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Neptune database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/neptune/neptune-connection-main.png) Field | Description ---|--- **Host name** | Enter the address of your AWS Neptune database here. **Port** | Enter the port number for your Neptune database. The default Neptune port is `8192`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [AWS Neptune IAM](../AWS-Credentials/) \- [DBeaver Profile](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. For detailed guide on driver properties please refer to the [official AWS Neptune documentation](https://s3.amazonaws.com/Neptune-downloads/drivers/JDBC/SimbaNeptuneJDBC-2.0.25.1001/doc/Simba+Neptune+JDBC+Connector+Install+and+Configuration+Guide.pdf). ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Neptune connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Secure connection configurations¶ DBeaver supports secure connections to your Neptune database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Neptune with DBeaver¶ DBeaver provides a host of features designed for Neptune databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ### Neptune database objects¶ DBeaver lets you view a range of Neptune database objects, such as: * Schemas * Tables * Columns ### Neptune additional features in DBeaver¶ DBeaver provides additional features compatible with Neptune, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Schema Management | [Schema Compare](../Schema-compare/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Netezza/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * Netezza [ Netezza ](./) Table of contents * Netezza specialty * Setting Up * Netezza connection settings * Connection details * Netezza driver properties * ODBC and JDBC driver configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Netezza with DBeaver * Netezza database objects * Netezza features in DBeaver * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Netezza specialty * Setting Up * Netezza connection settings * Connection details * Netezza driver properties * ODBC and JDBC driver configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Netezza with DBeaver * Netezza database objects * Netezza features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Netezza This guide provides instructions on how to set up and use Netezza with DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Netezza` option to connect to the Netezza database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/netezza/netezza-drivers.png) ## Netezza specialty¶ Netezza is a high-performance data warehousing appliance that excels in delivering fast data analytics and warehousing solutions through its massively parallel processing (MPP) architecture. This system is tailored for complex analytics on large datasets, often scaling to petabytes of data. Netezza simplifies analytics by allowing operations directly on compressed data, significantly reducing the storage requirements and enhancing query performance. The integrated architecture of Netezza, which combines database, server, and storage into a single, streamlined system, facilitates the easy management and scaling of data warehousing capabilities. ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, Kubernetes, SSL, and the setup of ODBC/JDBC drivers for Netezza. ## Netezza connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Netezza database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Netezza database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/netezza/netezza-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Netezza database. **URL** | If you are connecting via URL, enter the URL of your Netezza database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your Netezza database here. **Database/Schema** | Enter the name of the Netezza database/schema you want to connect to. **Port** | Enter the port number for your Netezza database. The default Netezza port is `5480`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Show all databases** ![](../images/commercial.png) | Displays all databases in the [Database Navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Use Owners for table structure view** ![](../images/commercial.png) | Show fully qualified table names in Database Navigator with owners names instead schemas. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Netezza connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Netezza driver properties¶ The settings for Netezza **Driver properties** enable you to adjust the performance of the Netezza JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Netezza database. For a complete walkthrough on setting up Netezza JDBC and ODBC drivers properties, you can refer to the official [Netezza JDBC documentation](https://www.ibm.com/docs/en/psfa/7.2.1?topic=configuration- installing-configuring-jdbc). These guides detail each driver's properties and how they can be used to optimize Netezza database connections. You can customize the Netezza driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Netezza database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC driver configuration¶ DBeaver provides extensive capabilities for managing Netezza database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Netezza database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Netezza database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Netezza with DBeaver¶ DBeaver provides a host of features designed for Netezza databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## Netezza database objects¶ DBeaver lets you view and manipulate a wide range of Netezza database objects. DBeaver has extensive support for various Netezza metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Tables * Unique Keys * Primary Keys * Foreign Keys * Views * Procedures * Sequences ![](../images/commercial.png) * Synonyms ![](../images/commercial.png) * Users ![](../images/commercial.png) * Data types ## Netezza features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous additional features compatible with Netezza, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management ![](../images/commercial.png) | [Session Manager](../Session-Manager-Guide/) Schema Management ![](../images/commercial.png) | [Schema Compare](../Schema-compare/) Data Visualization | [ERD Guide](../ER-Diagrams/) | [Query Execution plan](../Query-Execution-Plan/) ![](../images/commercial.png) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) ![](../images/commercial.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Parquet/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * Parquet [ Parquet ](./) Table of contents * Parquet Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features * Supported compression formats * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Parquet Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features * Supported compression formats 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. File drivers # Parquet Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use Parquet files with DBeaver. The **Parquet** driver allows you to work with Parquet data as if it were in a database. You can retrieve data and apply filters, sorting, and other operations, even combining data from multiple files. Important When using the **Parquet** driver, all connected Parquet files are read-only. To make changes, you need to update the original files outside DBeaver. Before you start, you need to create a connection in DBeaver and select the appropriate **Parquet** driver. If you haven’t done this, see our [Database Connection](../Create-Connection/) article. ![](../images/database/parquet/parquet-driver.png) You can open and work with Parquet files stored in your [Cloud Storage](../Cloud-Storage/) directly in DBeaver. Double-click a file to create a temporary connection. Files opened during a session appear in the **File databases** folder in [Database Navigator](../Database-Navigator/). These temporary connections are removed when you close DBeaver. ## Parquet Files driver connection settings¶ This section describes how to set up a connection using the **Parquet** driver. The connection settings page requires the following fields: ![](../images/database/parquet/parquet-connection-page.png) **Field** | **Description** ---|--- **Connect by (Path/URL)** | Choose whether to connect using a local host path or a URL. **File paths** | Specify the location of the Parquet file(s). Choose an action: \- **Edit** : Modify an existing file or folder selection. \- **Add** : Add a new file or folder. \- **Remove** : Delete a selected file or folder. When **Editing** or **Adding** , choose from: \- **File** : Select a single file. \- **Folder** : Choose a directory containing multiple Parquet files. For more details, see Folder structure section. \- **Remote** : Access a remote folder via [Cloud Storage](../Cloud-Storage/). This feature is available only in Ultimate and Team Editions. **Driver name** | This field will be auto-filled based on your selected driver type. **Driver settings** | If there are any specific driver settings, configure them here. Tip When using the **Folder** option, DBeaver scans the directory up to two levels deep for Parquet files. For more information, see folder structure. If you select a folder, DBeaver organizes files in schemas based on their directory structure. ## Features and capabilities¶ ### Advanced SQL query capabilities¶ The **Parquet** driver supports the full range of SQL queries: * **Simple queries** (e.g., `SELECT * FROM table`): Data is read directly from the Parquet file. * **Complex queries** (e.g., using `WHERE`, `JOIN`, `ORDER BY`, `GROUP BY`): When a complex query is executed for the first time, the driver imports the entire Parquet file into an internal database to enable advanced SQL functions. Subsequent queries run faster because the data is already imported into internal database. ### Folder structure¶ When working with a folder containing multiple Parquet files, DBeaver organizes them as follows: Folder structure | Schema in DBeaver ---|--- Root files | `Default` schema Subfolder files | Schema named after the subfolder Files in deeper folders | Ignored If your folder looks like this: Data/ ├── employees.parquet ├── sales.parquet └── Reports/ └── monthly.parquet └── yearly.parquet DBeaver will create: * `Default` schema: `employees`, `sales` * `Reports` schema: `monthly`, `yearly` Tip To focus on specific files, consider selecting individual files or folders when configuring the connection. ### Internal database¶ When you execute a complex query (such as `WHERE`, `JOIN`, `GROUP BY`, or `ORDER BY`.), on a **Parquet** file for the first time, the **Parquet** driver processes the data by importing it into a temporary internal SQLite database. By default, this internal database stores data temporarily on the disk during your session and is cleared when DBeaver restarts. To speed up queries on the same file in future sessions, you can specify the `internalDbFilePath` option in the **Driver properties** tab (e.g., `C:\User\database.db`) to reuse the processed data. ![](../images/database/parquet/internal-database-settings.png) Info For more details on driver properties, see [File-based driver properties](../File-based-driver-properties/). ### Additional features¶ DBeaver provides additional features compatible with **Parquet** driver, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Data Visualization | [Visual Query Builder](../Visual-Query-Builder/) | [Charts](../Managing-Charts/) ## Supported compression formats¶ DBeaver supports the following compression formats for Parquet files: Format | Supported out of the box | Notes ---|---|--- Zstandard (`zstd`) | Yes | Works without additional setup Snappy | No | Add the [`snappy-java`](https://mvnrepository.com/artifact/org.xerial.snappy/snappy-java) `JAR` to the driver library `LZ4_RAW` | No | Add the [`aircompressor`](https://mvnrepository.com/artifact/io.airlift/aircompressor) `JAR` to the driver library Info For details on adding a `JAR` files to the driver library, see [Driver Manager](../Driver-Manager/#update-driver-manually). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-PostgreSQL-on-Google-Cloud/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * Cloud SQL for PostgreSQL [ Cloud SQL for PostgreSQL ](./) Table of contents * Feature Highlights * Setting Up * PostgreSQL connection settings * Connection details * Driver properties * ODBC and JDBC driver configuration * Secure connection configurations * Secure Storage with Secret Providers * Powering Google Cloud PostgreSQL with DBeaver * Google Cloud PostgreSQL database objects * Google Cloud PostgreSQL additional features in DBeaver * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Feature Highlights * Setting Up * PostgreSQL connection settings * Connection details * Driver properties * ODBC and JDBC driver configuration * Secure connection configurations * Secure Storage with Secret Providers * Powering Google Cloud PostgreSQL with DBeaver * Google Cloud PostgreSQL database objects * Google Cloud PostgreSQL additional features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # Cloud SQL for PostgreSQL Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Google Cloud SQL for PostgreSQL is a managed database service provided by [Google Cloud](https://cloud.google.com/sql/postgresql?hl=en), offering the robust capabilities of Google Cloud PostgreSQL with the added benefits of cloud hosting. This guide is designed to assist in the setup and management of Google Cloud SQL for PostgreSQL databases using DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `CloudSQL - PostgreSQL` option to connect to the Google Cloud SQL service. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/gcp_postgresql/gcp-postgresql-drivers.png) Tip You can connect to your databases using the [Cloud Explorer](../Cloud- Explorer/). ## Feature Highlights¶ DBeaver extends beyond standard SQL tasks, offering a suite of PostgreSQL- specific features. These capabilities enhance the functionality and management of Google Cloud PostgreSQL databases, catering to specific needs and advanced use cases. * **Data Types** : DBeaver supports complex data types unique to this system. This includes Arrays and various structures, enabling intricate data organization and manipulation. * **Extensions and Security** : DBeaver includes robust support for Extensions, broadening the database's functionality. It also provides comprehensive security features, encompassing Permissions, Policies, and Roles management, ensuring thorough control over database access and operations. * **Data Organization** : For effective data handling, DBeaver supports Partitions. This feature assists in efficient data segmentation and organization, enhancing database performance and management. * **External Data Integration** : The platform also facilitates the integration of Foreign Tables. This feature enables seamless access and manipulation of external data sources, providing a more flexible and expansive data management environment. ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for Google Cloud PostgreSQL. Note The connection process in DBeaver utilizes the standard PostgreSQL driver, tailored to interact with the Google Cloud SQL for PostgreSQL service, highlighting its cloud-based characteristics. ## PostgreSQL connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Google Cloud PostgreSQL database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Google Cloud PostgreSQL database. 1. The first page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/gcp_postgresql/gcp-postgresql-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Google Cloud PostgreSQL database. **URL** | If you are connecting via URL, enter the URL of your Google Cloud PostgreSQL database here. This field is hidden if you are connecting via the host. **Host/Instance** | For a direct connection to a Google Cloud SQL instance, use the format `project:region:instance`. Here, `project` refers to your Google Cloud project ID, `region` denotes the geographical location of your instance, and `instance` is the unique ID of your Google Cloud SQL instance. **Database** | Enter the name of the Google Cloud PostgreSQL database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Google Cloud IAM](../GCP-Credentials/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Local Client** | Specify the local client, see our article about [local client configuration](../Local-Client-Configuration/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The second page of the connection settings offers additional options that allow you to customize your further connection to the Google Cloud PostgreSQL database. ![](../images/database/gcp_postgresql/gcp-postgresql-connection-settings.png) Field | Description ---|--- **Show template databases** | Displays template databases. This option is available when **Show all databases** is checked. **Show databases unavailable for connection** | Displays databases unavailable. This option is available when **Show all databases** is checked. **Show databases statistics** | Displays statistics for databases. **Read all data types** | Reads all data types from the server. **Read table keys with columns** | Reads table keys with columns. **Replace legacy timezone** | Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like **Europe/Kyiv** or **Asia/Calcutta**. Only these two timezones are affected. **Show`$$` quote as** | Displays `$$` quotes as code blocks or strings. **Show`$tagName$` quote as** | Displays `$tagName$` quotes as code blocks or strings. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Google Cloud PostgreSQL connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Driver properties¶ While managing PostgreSQL databases hosted on Google Cloud with DBeaver, it's important to understand that the underlying driver is the standard PostgreSQL JDBC and ODBC driver. The settings for Google Cloud PostgreSQL **Driver properties** enable you to adjust the performance of the PostgreSQL JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Google Cloud PostgreSQL database. For a complete walkthrough on setting up PostgreSQL JDBC and ODBC drivers properties, you can refer to the official [PostgreSQL JDBC documentation](https://jdbc.postgresql.org/documentation/use/) and [PostgreSQL ODBC documentation](https://odbc.postgresql.org/). These guides detail each driver's properties and how they can be used to optimize Google Cloud PostgreSQL database connections. You can customize the PostgreSQL driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Google Cloud PostgreSQL database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC driver configuration¶ DBeaver provides extensive capabilities for managing Google Cloud PostgreSQL database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Google Cloud PostgreSQL database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure connection configurations¶ DBeaver supports secure connections to your Google Cloud PostgreSQL database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Google Cloud PostgreSQL with DBeaver¶ DBeaver provides a host of features designed for Google Cloud PostgreSQL databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## Google Cloud PostgreSQL database objects¶ DBeaver lets you view and manipulate a wide range of Google Cloud PostgreSQL database objects. DBeaver has extensive support for various PostgreSQL metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Data types * Tables * Columns * Constraints * Indexes * Foreign Keys * Dependencies * References * Partitions * Triggers * Rules * Policies * Foreign Tables * Views * Materialized Views * Functions * Sequences * Data types * Aggregate functions * Event Triggers * Extensions * Storage * Tablespaces * Roles * Administer * Jobs * Session Manager * Lock Manager ## Google Cloud PostgreSQL additional features in DBeaver¶ DBeaver provides additional features compatible with Google Cloud PostgreSQL, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Lock Management | [Lock Manager](../Lock-Manager/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) | [Query Execution plan](../Query-Execution-Plan/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-PostgreSQL/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * PostgreSQL [ PostgreSQL ](./) Table of contents * Setting Up * PostgreSQL connection settings * Connection details * PostgreSQL driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering PostgreSQL with DBeaver * PostgreSQL database objects * PostgreSQL features in DBeaver * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * PostgreSQL connection settings * Connection details * PostgreSQL driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering PostgreSQL with DBeaver * PostgreSQL database objects * PostgreSQL features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. PostgreSQL # PostgreSQL This guide provides instructions on how to set up and use PostgreSQL with DBeaver. DBeaver offers extensive support for PostgreSQL, but it might not cover all possible functionalities. If DBeaver is missing a feature you need, please submit a request through our [GitHub page](https://github.com/dbeaver/dbeaver/issues/new/choose). If you are a developer, you have the option to enhance DBeaver's capabilities by contributing your own code. Before you start, you must create a connection in DBeaver and select PostgreSQL. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the PostgreSQL server using a specific driver, it supports all versions of PostgreSQL, but the correct driver must be selected: use **PostgreSQL (old)** for versions below 8.x and **PostgreSQL** for newer versions. DBeaver also supports PostgreSQL extensions such as **EDB** , **Google Cloud SQL for PostgreSQL** and **Fujitsu Enterprise Postgres**. You must select the appropriate driver in the **Connect to a database** window for these extensions. ![](../images/database/postgresql/postgre-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for PostgreSQL. ## PostgreSQL connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a PostgreSQL database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your PostgreSQL database. 1. The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/postgresql/postgre-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your PostgreSQL database. **URL** | If you are connecting via URL, enter the URL of your PostgreSQL database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your PostgreSQL database here. **Database** | Enter the name of the PostgreSQL database you want to connect to. **Show all databases** | Displays all databases in the [database navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Port** | Enter the port number for your PostgreSQL database. The default PostgreSQL port is `5432`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [AWS RDS IAM Authentication](../AWS-Credentials/) ![](../images/commercial.png) \- [Azure AD Authentication for PostgreSQL](../Authentication-Microsoft-Entra- ID/) ![](../images/commercial.png) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [PostgreSQL Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) \- [PostgreSQL PgPass Authentication](../Authentication-PostgreSQL-Pgpass/) \- [PostgreSQL SSPI Authentication (Windows SSO)](../Authentication- PostgreSQL-SSPI/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Local Client** | Specify the local client, see our article about [local client configuration](../Local-Client-Configuration/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The second page of the connection settings offers additional options that allow you to customize your further connection to the PostgreSQL database. ![](../images/database/postgresql/postgre-connection-postgresql.png) Field | Description ---|--- **Show template databases** | Displays template databases. This option is available when **Show all databases** is checked. **Show databases unavailable for connection** | Show databases not available for connection in database list. This option is available when **Show all databases** is checked. **Show databases statistics** | Displays statistics for databases. **Read all data types** | Reads all data types from the server (including arrays). **Read table keys with columns** | Enable reading table constraints during the column reading stage to ensure accurate recognition of keys. Note that this setting may decrease metadata loading performance. **Replace legacy timezone** | Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like **Europe/Kyiv** or **Asia/Calcutta**. Only these two timezones are affected. **Show`$$` quote as** | Displays `$$` quotes as code blocks or strings. **Show`$tagName$` quote as** | Displays `$tagName$` quotes as code blocks or strings. **Use prepared statements** | Uses prepared statements for SQL execution. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your PostgreSQL connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## PostgreSQL driver properties¶ The settings for PostgreSQL **Driver properties** enable you to adjust the performance of the PostgreSQL JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your PostgreSQL database. For a complete walkthrough on setting up PostgreSQL JDBC and ODBC drivers properties, you can refer to the official [PostgreSQL JDBC documentation](https://jdbc.postgresql.org/documentation/use/) and [PostgreSQL ODBC documentation](https://odbc.postgresql.org/). These guides detail each driver's properties and how they can be used to optimize PostgreSQL database connections. You can customize the PostgreSQL driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your PostgreSQL database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing PostgreSQL database connections via ODBC/JDBC drivers. This functionality enables you to connect to your PostgreSQL database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. You can find a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver in our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your PostgreSQL database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering PostgreSQL with DBeaver¶ DBeaver provides a host of features designed for PostgreSQL databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## PostgreSQL database objects¶ DBeaver lets you view and manipulate a wide range of PostgreSQL database objects. DBeaver has extensive support for various PostgreSQL metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Data types * Tables * Columns * Constraints * Indexes * Foreign Keys * Dependencies * References * Partitions * Triggers * Rules * Policies * Foreign Tables * Views * Materialized Views * Functions * Sequences * Data types * Aggregate functions * Event Triggers * Extensions * Storage * Tablespaces * Roles * Administer * Jobs * Session Manager * Lock Manager For a practical guide on creating new tables and working with various database objects in PostgreSQL, check out our [tutorial](../New-Table-Creation/). ## PostgreSQL features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for PostgreSQL. Beyond regular SQL operations, DBeaver provides a range of PostgreSQL-specific capabilities, such as: Category | Feature ---|--- Data Types | [PostgreSQL Arrays](../PostgreSQL-Arrays/) | PostgreSQL Structures Extensions | [PostgreSQL Extensions](../PostgreSQL-Extensions/) Security | PostgreSQL Permissions | PostgreSQL Policies | PostgreSQL Roles Data Organization | [PostgreSQL Partitions](../How-to-work-with-database-Partitions/) Database Management | PostgreSQL Dependencies | PostgreSQL Tools External Data | PostgreSQL Foreign Tables Additional features compatible with PostgreSQL, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Lock Management | [Lock Manager](../Lock-Manager/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-SQLite/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * SQLite [ SQLite ](./) Table of contents * Setting Up * SQLite connection configuration * General SQLite connection settings * SQLite Crypt connection settings * SQLite extensions * Extensions in Community Edition * Remote database connection * Synchronization * Connection details * SQLite driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering SQLite with DBeaver * SQLite database objects * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * SQLite connection configuration * General SQLite connection settings * SQLite Crypt connection settings * SQLite extensions * Extensions in Community Edition * Remote database connection * Synchronization * Connection details * SQLite driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering SQLite with DBeaver * SQLite database objects 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Embedded # SQLite This guide provides instructions on how to set up and use SQLite with DBeaver. Before you start, you must create a connection in DBeaver and select SQLite. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the SQLite server using a specific driver, supporting all versions of SQLite. DBeaver also supports SQLite extensions such as SQLite Crypt (Cipher). You can also create a sample database in DBeaver. See our [Creating a Sample Database article](../Sample-Database/) for more information. ![](../images/database/sqlite/sqlite-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, Kubernetes, and the setup of ODBC/JDBC drivers for SQLite. ### SQLite connection configuration¶ #### General SQLite connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a SQLite database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your SQLite database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/sqlite/sqlite-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your SQLite database. **URL** | If you are connecting via URL, enter the URL of your SQLite database here. This field is disabled if you're connecting via the host. **Path** | Enter the path to the database file. **Database is remote** | If the SQLite database resides on a remote server, check this box. Reed more. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### SQLite Crypt connection settings¶ This subsection outlines the settings to establish a connection to encrypted SQLite databases. ![](../images/database/sqlite/sqlite-crypt-connection-main.png) Field | Description ---|--- **Path** | Enter the path to the database file. **Cipher** | Choose the encryption algorithm for your database. Available options include `AES 128`, `AES 256`, `ChaCha20`, `SQLCipher`, `SQLCipher v1`, `SQLCipher v2`, `SQLCipher v3`, `SQLCipher v4`, `RC4`, and `Custom` option. For more details, refer to the [SQLite Ciphers documentations](https://utelle.github.io/SQLite3MultipleCiphers/). **Password** | This field will be auto-filled based on your selected driver type. **Cipher parameters** | These parameters are read-only and change according to the chosen Cipher. You can customize them only if you select **Custom** in the Cipher field. #### SQLite extensions¶ DBeaver supports the addition of SQLite extensions to enhance database functionality. Extensions can introduce new custom functions, collating sequences, or virtual tables, which are useful for advanced data manipulation or utilizing encryption algorithms not natively supported. ![](../images/database/sqlite/sqlite-extensions.png) To import an SQLite extension, do the following: 1. Locate the **Extensions** tab in your SQLite connection settings. 2. Click on the **Add** button. 3. Enter the path to the extension file you wish to import. Note Make sure the extension you are importing matches your operating system and CPU architecture to ensure compatibility. ##### Extensions in Community Edition¶ To enable and load SQLite extensions in the Community Edition, follow these steps: 1. Set the `enable_load_extension` property to `true` in Driver properties tab. 2. Execute `SELECT load_extension('extension-name.so')` either as a bootstrap query in the [Connection Initialization Settings](../Configure-Connection-Initialization-Settings/) or in the [SQL editor](../SQL-Editor/). Note You need to have a 64-bit version of the extension library. #### Remote database connection¶ When connecting to a remote SQLite database in DBeaver: 1. Specify a local path in the connection settings. This path should mirror the path on the remote server. 2. Set up an [SSH](../SSH-Configuration/) tunnel. ##### Synchronization¶ To maintain consistency between your local SQLite database and the remote server, follow these steps: 1. Make local changes to your database. 2. Save changes. 3. Click the **Synchronize** button ![](../images/database/sqlite/Synchronize-button.png) in the main [toolbar](../Application-Window-Overview/#toolbar). 4. A dialog will prompt you with two options: ![](../images/database/sqlite/SQLite-synchronization-window.png) * **Save local changes to server** : This will push your local changes to the server. * **Load remote changes from server** : This will pull the server's data to your local environment. After selecting this, refresh the result set to view updated data. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with SQLite database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### SQLite driver properties¶ The settings for SQLite **Driver properties** enable you to adjust the performance of the SQLite JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your SQLite database. For a complete walkthrough on setting up SQLite JDBC and ODBC drivers properties, you can refer to the official [SQLite JDBC documentation](https://github.com/xerial/sqlite-jdbc) and [SQLite ODBC documentation](http://www.ch-werner.de/sqliteodbc/html/index.html). These guides detail each driver's properties and how they can be used to optimize SQLite database connections. You can customize the SQLite driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your SQLite database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing SQLite database connections via ODBC/JDBC drivers. This functionality enables you to connect to your SQLite database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. This process is similar across most databases that support ODBC/JDBC drivers. For a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver, you can refer to our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your SQLite database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) ![](../images/commercial.png) * [**Proxy Configuration**](../Proxy-configuration/) ![](../images/commercial.png) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering SQLite with DBeaver¶ DBeaver provides a host of features designed for SQLite databases. This includes the ability to view and manage tables, along with numerous unique capabilities aimed at optimizing database operations. ### SQLite database objects¶ DBeaver lets you view and manipulate a few SQLite database objects. DBeaver has extensive support for various SQLite metadata types, allowing you to interact with: * Tables * Views Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Salesforce/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * Salesforce [ Salesforce ](./) Table of contents * Setting Up * Salesforce connection settings * Connection details * Salesforce driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Salesforce with DBeaver * Salesforce database objects * Salesforce Object Query Language * SOQL vs SQL * Examples * Simple Select * Select with Filtering * Select with Grouping * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * Salesforce connection settings * Connection details * Salesforce driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Salesforce with DBeaver * Salesforce database objects * Salesforce Object Query Language * SOQL vs SQL * Examples * Simple Select * Select with Filtering * Select with Grouping 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. Salesforce # Salesforce Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use Salesforce with DBeaver. Before you start, you must create a connection in DBeaver and select Salesforce. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the Salesforce server using a specific driver. To use it, choose the right Salesforce driver in the Connect to a database window. ![](../images/database/salesforce/salesforce-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH and proxies. ### Salesforce connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Salesforce database using DBeaver. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/salesforce/salesforce-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | [Select the appropriate driver](../ODBC-JDBC-Driver/) for your Salesforce database. **URL** | If you are connecting via URL, enter the URL of your Salesforce database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your Salesforce database here. **Port** | Enter the port number for your Salesforce database. The default Salesforce port is `443`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) \- [Salesforce authentication](../Authentication-Salesforce/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Salesforce database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Salesforce driver properties¶ Salesforce is not a traditional Relational Database Management System (RDBMS), and as such, it does not come with a standard JDBC driver. DBeaver uses REST API for connecting to the Salesforce server. There are no particular properties for configuration at this time. The driver is designed with the current functionality of the Salesforce platform in mind, focusing solely on providing the ability to read data. ### Secure Connection Configurations¶ DBeaver supports secure connections to your Salesforce database. Guidance on configuring such connections, specifically **SSH** **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Salesforce with DBeaver¶ At the current version of DBeaver, the Salesforce database driver allows read- only access to its data, enabling you to execute `SELECT` queries to view data. This includes the ability to use [filters](../Data-Filters/), [groupings](../Grouping-Panel/), [data export](../Data-export/), [Diagrams](../ER-Diagrams/) and other functionalities of DBeaver for viewing and analyzing the data. ### Salesforce database objects¶ ![](../images/database/salesforce/salesforce-database-navigator.png) DBeaver lets you view Salesforce database objects and has support for a limited number of Salesforce metadata types, allowing you to interact with a select variety of database objects, such as: * Tables * Columns * Keys * Foreign Keys * References * Data Types ## Salesforce Object Query Language¶ SOQL is a query language used to search Salesforce data. Within DBeaver, you can utilize SOQL to execute read-only `SELECT` queries on Salesforce data. ### SOQL vs SQL¶ SOQL is specifically tailored for querying Salesforce data and has some distinct differences from traditional SQL: * Read-Only Queries: SOQL is used primarily for querying data, not for data manipulation. In Salesforce, data insertion and manipulation are typically handled through the platform's user interface, APIs, or specialized data loading tools, rather than through SOQL. * Limited `JOIN` Operations: Unlike SQL, SOQL does not support all types of `JOIN` operations. * No Arbitrary Expressions: SOQL does not allow arbitrary expressions or calculations in the `SELECT` clause, unlike SQL. ### Examples¶ Here are some brief examples, you can find more details in the official [SOQL tutorial](https://www.salesforcetutorial.com/soql-salesforce-object-query- language/): #### Simple Select¶ Retrieve the `Name` and `Id` of all accounts: SELECT Id, Name FROM Account #### Select with Filtering¶ Retrieve accounts with a specific status: SELECT Id, Name FROM Account WHERE Status = 'Active' #### Select with Grouping¶ Group accounts by `status` and count them: SELECT Status, COUNT(Id) FROM Account GROUP BY Status Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Teradata/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * Teradata [ Teradata ](./) Table of contents * Setting Up * Teradata connection settings * Connection details * Teradata driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Teradata with DBeaver * Teradata database objects * Teradata features in DBeaver * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * Teradata connection settings * Connection details * Teradata driver properties * ODBC and JDBC Driver Configuration * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Teradata with DBeaver * Teradata database objects * Teradata features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. Teradata # Teradata This guide provides instructions on how to set up and use Teradata with DBeaver. DBeaver enhances your experience with specialized support for Teradata features, including unique data types like Vargraphic and Long Vargraphic, as well as advanced security options through Roles and Profiles. Before you start, you must create a connection in DBeaver and select Teradata. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. DBeaver interacts with the Teradata server using a specific driver, supporting all versions of Teradata. ![](../images/database/teradata/teradata-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, Kubernetes, and the setup of ODBC/JDBC drivers for Teradata. ### Teradata connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Teradata database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Teradata database. 1. The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/teradata/teradata-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **Driver Type** | Select the appropriate driver for your Teradata database. **URL** | If you are connecting via URL, enter the URL of your Teradata database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your Teradata database here. **Database/Schema** | Enter the name of the Teradata database/schema you want to connect to. **Port** | Enter the port number for your Teradata database. The default Teradata port is `1025`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Kerberos](../Kerberos-Authentication/) ![](../images/commercial.png) \- [LDAP Mechanism](../Authentication-LDAP-Mechanism/) ![](../images/commercial.png) \- Single Sign-On ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Use TLS protocol** | If you enable this checkbox, the connection will use TLS (Transport Layer Security) to encrypt the data that is transmitted between DBeaver and the Teradata database. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The second page of the connection settings offers additional options that allow you to customize your further connection to the Teradata database. ![](../images/database/teradata/teradata-additional-options.png) Field | Description ---|--- **Show all databases** | Displays all server databases in the [database navigator](../Database-Navigator/). **Show databases and users hierarchically** | Enable this checkbox to view databases and associated user permissions in a hierarchical structure. **Show only databases in the navigator tree** | Displays databases in the navigator tree and exclude other types of objects like schemas, tables, and users. **Use Teradata data format** | Use data format specified in the FORMAT clause instead of default formatting settings. #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with MySQL database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Teradata driver properties¶ The settings for Teradata **Driver properties** enable you to adjust the performance of the Teradata JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Teradata database. For a complete walkthrough on setting up Teradata JDBC and ODBC drivers properties, you can refer to the official [Teradata JDBC documentation](https://downloads.teradata.com/download/connectivity/jdbc- driver) and [Teradata ODBC documentation](https://docs.teradata.com/r/ODBC- Driver-for-Teradata-User-Guide/June-2022). These guides detail each driver's properties and how they can be used to optimize Teradata database connections. You can customize the Teradata driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Teradata database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### ODBC and JDBC Driver Configuration¶ DBeaver provides extensive capabilities for managing Teradata database connections via ODBC/JDBC drivers. This functionality enables you to connect to your Teradata database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available. This process is similar across most databases that support ODBC/JDBC drivers. For a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver, you can refer to our [ODBC Driver Configuration](../ODBC-JDBC-Driver/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your Teradata database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Teradata with DBeaver¶ DBeaver provides a host of features designed for Teradata databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### Teradata database objects¶ DBeaver lets you view and manipulate a wide range of Teradata database objects. DBeaver has extensive support for various Teradata metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Tables * Columns * Keys * Foreign keys * Indexes * References * Triggers * Views * Indexes * Procedures * Macros * Data Types * Administration * Zones * Maps * Users * Roles * Profiles ### Teradata features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for Teradata. Beyond regular SQL operations, DBeaver provides a range of Teradata-specific capabilities, such as: Category | Feature ---|--- Data Types | Teradata Vargraphic and Long Vargraphic Security | Teradata Roles and Profiles Database Management | Teradata Procedures | Teradata Macros Additional features compatible with Teradata, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [ERD Guide](../ER-Diagrams/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Trino/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * Trino [ Trino ](./) Table of contents * Trino specialty * Setting up * Trino connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Trino with DBeaver * Trino database objects * Trino Features in DBeaver * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Trino specialty * Setting up * Trino connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Trino with DBeaver * Trino database objects * Trino Features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Trino This guide provides instructions on how to set up and use Trino with DBeaver. Before you start, you must create a connection in DBeaver and select Trino. If you haven’t done this yet, see our [Database Connection](../Create- Connection/) article. DBeaver connects to Trino using a dedicated JDBC driver. It supports all modern Trino versions. If you’re working with older Presto (PrestoSQL) setups, you can also use the **Presto** driver. For newer deployments, use the **Trino** driver for better compatibility and feature support. ![](../images/database/trino/trino-drivers.png) ## Trino specialty¶ Trino is a fast, distributed SQL engine designed for querying large datasets across different data sources. It lets you work with data where it lives - whether in databases, data lakes, or file systems - without copying or moving it. You can run SQL queries across multiple systems at once, joining data from sources like Hive, Iceberg, PostgreSQL, or S3. Trino is built for scalability and performance. It uses a coordinator and worker architecture that supports high concurrency and horizontal scaling. Security and access control can be managed using external tools or plugins, with support for various authentication methods and permissions. Info For more, see the [Trino documentation](https://trino.io/docs/current/). ## Setting up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, AWS SSM and Kubernetes. ## Trino connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Trino database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Trino database. The connection settings page requires you to fill in specific fields to establish the initial connection. ![](../images/database/trino/trino-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **URL** | If you are connecting via URL, enter the URL of your Trino database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your Trino database here. **Database/Schema** | Enter the name of the Trino database you want to connect to. **Port** | Enter the port number for your Trino database. The default Trino port is `8080`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Trino Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Trino database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Secure Connection Configurations¶ DBeaver supports secure connections to your Trino database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Trino with DBeaver¶ DBeaver provides a host of features designed for Trino databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ## Trino database objects¶ DBeaver lets you view and manipulate a wide range of Trino database objects. DBeaver has extensive support for various Trino metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases (schemas) * Tables * Columns * Views ## Trino Features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for Trino. Beyond regular SQL operations, DBeaver provides a range of Trino-specific capabilities, such as: Category | Feature ---|--- Data Types | Native support for complex and custom types: `map`, `row`, `json`, `hyperloglog`, `geometry`, `ipaddress`, `uuid`, `jsonpath`, etc. Metadata Access | Explore `information_schema` and Trino's internal `system` schemas Additional features compatible with Trino, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Data Compare | [Data Compare](../Data-compare/) ![](../images/commercial.png) Data Generation | [Mock Data Generation](../Mock-Data-Generation-in-DBeaver/) ![](../images/commercial.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-XLSX/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * XLSX [ XLSX ](./) Table of contents * XLSX Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Structuring XLSX files with a schema * Why use a DDL file * How to create a DDL file * Folder structure * Internal database * Additional features * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * XLSX Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Structuring XLSX files with a schema * Why use a DDL file * How to create a DDL file * Folder structure * Internal database * Additional features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. File drivers # XLSX Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use XLSX files with DBeaver. The **XLSX** driver allows you to work with XLSX data as if it were in a database. You can retrieve data and apply filters, sorting, and other operations, even combining data from multiple files. Important When using the **XLSX** driver, all connected XLSX files are read-only. To make changes, you need to update the original files outside DBeaver. Before you start, you need to create a connection in DBeaver and select the **XLSX** driver. If you haven’t done this, see our [Database Connection](../Create-Connection/) article. ![](../images/database/xlsx/xlsx-driver.png) You can open and work with XLSX files stored in your [Cloud Storage](../Cloud- Storage/) directly in DBeaver. Double-click a file to create a temporary connection. Files opened during a session appear in the **File databases** folder in [Database Navigator](../Database-Navigator/). These temporary connections are removed when you close DBeaver. ## XLSX Files driver connection settings¶ This section describes how to set up a connection using the **XLSX** driver. The connection settings page requires the following fields: ![](../images/database/xlsx/xlsx-connection-page.png) **Field** | **Description** ---|--- **Connect by (Path/URL)** | Choose whether to connect using a local host path or a URL. **File paths** | Specify the location of the XLSX file(s). Choose an action: \- **Edit** : Modify an existing file or folder selection. \- **Add** : Add a new file or folder. \- **Remove** : Delete a selected file or folder. When **Editing** or **Adding** , choose from: \- **File** : Select a single file. \- **Folder** : Choose a directory containing multiple XLSX files. For more details, see Folder structure section. \- **Remote** : Access a remote folder via [Cloud Storage](../Cloud-Storage/). This feature is available only in Ultimate and Team Editions. **Driver name** | This field will be auto-filled based on your selected driver type. **Driver settings** | If there are any specific driver settings, configure them here. Tip When using the **Folder** option, DBeaver scans the directory up to two levels deep for XLSX files. For more information, see folder structure. If you select a folder, DBeaver organizes files in schemas based on their directory structure. ## Features and capabilities¶ ### Advanced SQL query capabilities¶ The **XLSX** driver supports the full range of SQL queries: * **Simple queries** (e.g., `SELECT * FROM table`): Data is read directly from the XLSX file. * **Complex queries** (e.g., using `WHERE`, `JOIN`, `ORDER BY`, `GROUP BY`): When a complex query is executed for the first time, the driver imports the entire XLSX file into an internal database to enable advanced SQL functions. Subsequent queries run faster because the data is already imported into internal database. ### Structuring XLSX files with a schema¶ XLSX files don’t include metadata about their structure, such as column names or data types. To enhance how DBeaver interprets these files, you can define a schema using a DDL (Data Definition Language) file. #### Why use a DDL file¶ A DDL file helps DBeaver interpret your data more accurately by defining: * Column names * Data types * Optional indexes for better performance #### How to create a DDL file¶ 1. Create a `.ddl` file with the same name as your XLSX file, placing it in the same directory (e.g., `employees.xlsx` and `employees.xlsx.ddl`). 2. Write a schema using the `CREATE TABLE` statement: CREATE TABLE employees ( id INTEGER, name TEXT NOT NULL, age INTEGER, department TEXT ); CREATE INDEX idx_employees_id ON employees (id); If your XLSX file contains multiple sheets, you can define multiple `CREATE TABLE` statements in a single DDL file, one for each worksheet. The table names in the DDL file should match the worksheet names: CREATE TABLE employees ( id INTEGER, name TEXT NOT NULL, age INTEGER DEFAULT 30, department TEXT ); CREATE TABLE sales ( sale_id INTEGER, product TEXT, quantity INTEGER, price DECIMAL(10, 2) ); Important If the DDL file contains errors, DBeaver will ignore it. You can still query the file, but column types will be inferred from the data. ### Folder structure¶ When working with a folder containing multiple XLSX files, DBeaver organizes them as follows: Folder structure | Schema in DBeaver ---|--- Root files | `Default` schema Subfolder files | Schema named after the subfolder Files in deeper folders | Ignored Note Each file becomes a schema, and each sheet in a file becomes a table in that schema. If your folder looks like this: Data/ ├── employees.xlsx │ ├── Sheet1 │ ├── Sheet2 ├── sales.xlsx │ ├── SalesData │ ├── Summary └── Reports/ ├── monthly.xlsx │ ├── January │ ├── February ├── yearly.xlsx ├── 2023 ├── 2024 DBeaver will create: * **Schema** : `Default` **Tables** : * `employees.Sheet1` * `employees.Sheet2` * `sales.SalesData` * `sales.Summary` * **Schema** : `Reports` **Tables** : * `monthly.January` * `monthly.February` * `yearly.2023` * `yearly.2024` Tip To focus on specific files, consider selecting individual files or folders when configuring the connection. ### Internal database¶ When you execute a complex query (such as `WHERE`, `JOIN`, `GROUP BY`, or `ORDER BY`.), on an **XLSX** file for the first time, the **XLSX** driver processes the data by importing it into a temporary internal SQLite database. By default, this internal database stores data temporarily on the disk during your session and is cleared when DBeaver restarts. To speed up queries on the same file in future sessions, you can specify the `internalDbFilePath` option in the **Driver properties** tab (e.g., `C:\User\database.db`) to reuse the processed data. ![](../images/database/xlsx/internal-database-settings.png) Info For more details on driver properties, see [File-based driver properties](../File-based-driver-properties/). ### Additional features¶ DBeaver provides additional features compatible with **XLSX** driver, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Data Visualization | [Visual Query Builder](../Visual-Query-Builder/) | [Charts](../Managing-Charts/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-XML/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * XML [ XML ](./) Table of contents * XML Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * XML Files driver connection settings * Features and capabilities * Advanced SQL query capabilities * Folder structure * Internal database * Additional features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. File drivers # XML Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use XML files with DBeaver. The **XML** driver supports standard XML files, including both attribute-based and nested element-based structures. You can retrieve data and apply filters, sorting, and other operations, even combining data from multiple files. Important When using the **XML** driver, all connected **XML** files are read-only. To make changes, you need to update the original files outside DBeaver. Before you start, you need to create a connection in DBeaver and select the appropriate **XML** driver. If you haven’t done this, see our [Database Connection](../Create-Connection/) article. ![](../images/database/xml/xml-drivers.png) You can open and work with XML files stored in your [Cloud Storage](../Cloud- Storage/) directly in DBeaver. Double-click a file to create a temporary connection. Files opened during a session appear in the **File databases** folder in [Database Navigator](../Database-Navigator/). These temporary connections are removed when you close DBeaver. ## XML Files driver connection settings¶ This section describes how to set up a connection using the **XML** driver. The connection settings page requires the following fields: ![](../images/database/xml/xml-connection-page.png) **Field** | **Description** ---|--- **Connect by (Path/URL)** | Choose whether to connect using a local host path or a URL. **File paths** | Specify the location of the XML file(s). Choose an action: \- **Edit** : Modify an existing file or folder selection. \- **Add** : Add a new file or folder. \- **Remove** : Delete a selected file or folder. When **Editing** or **Adding** , choose from: \- **File** : Select a single file. \- **Folder** : Choose a directory containing multiple XML files. For more details, see Folder structure section. \- **Remote** : Access a remote folder via [Cloud Storage](../Cloud-Storage/). This feature is available only in Ultimate and Team Editions. **Driver name** | This field will be auto-filled based on your selected driver type. **Driver settings** | If there are any specific driver settings, configure them here. Tip When using the **Folder** option, DBeaver scans the directory up to two levels deep for XML files. For more information, see folder structure. If you select a folder, DBeaver organizes files in schemas based on their directory structure. ## Features and capabilities¶ ### Advanced SQL query capabilities¶ The **XML** driver supports the full range of SQL queries: * **Simple queries** (e.g., `SELECT * FROM table`): Data is read directly from the XML file. * **Complex queries** (e.g., using `WHERE`, `JOIN`, `ORDER BY`, `GROUP BY`): When a complex query is executed for the first time, the driver imports the entire XML file into an internal database to enable advanced SQL functions. Subsequent queries run faster because the data is already imported into an internal database. ### Folder structure¶ When working with a folder containing multiple XML files, DBeaver organizes them as follows: Folder structure | Schema in DBeaver ---|--- Root files | `Default` schema Subfolder files | Schema named after the subfolder Files in deeper folders | Ignored If your folder looks like this: Data/ ├── employees.xml ├── sales.xml └── Reports/ └── monthly.xml └── yearly.xml DBeaver will create: * `Default` schema: `employees`, `sales` * `Reports` schema: `monthly`, `yearly` Tip To focus on specific files, consider selecting individual files or folders when configuring the connection. ### Internal database¶ When you execute a complex query (such as `WHERE`, `JOIN`, `GROUP BY`, or `ORDER BY`.), on an **XML** file for the first time, the **XML** driver processes the data by importing it into a temporary internal SQLite database. By default, this internal database stores data temporarily on the disk during your session and is cleared when DBeaver restarts. To speed up queries on the same file in future sessions, you can specify the `internalDbFilePath` option in the **Driver properties** tab (e.g., `C:\User\database.db`) to reuse the processed data. ![](../images/database/xml/internal-database-settings.png) Info For more details on driver properties, see [File-based driver properties](../File-based-driver-properties/). ### Additional features¶ DBeaver provides additional features compatible with **XML** driver, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Export](../Data-export/) Data Visualization | [Visual Query Builder](../Visual-Query-Builder/) | [Charts](../Managing-Charts/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-driver-Yellowbrick/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * Yellowbrick [ Yellowbrick ](./) Table of contents * Yellowbrick specialty * Setting Up * Yellowbrick connection settings * Connection details * Yellowbrick driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Yellowbrick with DBeaver * Yellowbrick database objects * Yellowbrick features in DBeaver * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Yellowbrick specialty * Setting Up * Yellowbrick connection settings * Connection details * Yellowbrick driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Yellowbrick with DBeaver * Yellowbrick database objects * Yellowbrick features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Yellowbrick This guide provides instructions on how to set up and use Yellowbrick with DBeaver. Before you start, you must start creating a connection in DBeaver and select Yellowbrick. If you haven’t done this yet, see our [Create Connection](../Create-Connection/) article. ![](../images/database/yellowbrick/yellowbrick-driver.png) ## Yellowbrick specialty¶ Yellowbrick is a high-performance, cloud-native data warehouse built for complex analytics at scale. It’s optimized for fast SQL execution on large volumes of data, making it ideal for enterprise workloads that demand speed and concurrency. Yellowbrick is based on PostgreSQL, so it supports standard SQL and offers compatibility with PostgreSQL clients, drivers, and tools. You can run complex queries using familiar syntax, with low-latency results even on billions of rows. It integrates easily with BI tools, ETL pipelines, and existing data ecosystems. Yellowbrick supports hybrid deployments - on-premises, in the cloud, or both - and includes features for workload management, high availability, and enterprise-grade security. Info For more, see the [Yellowbrick documentation](https://docs.yellowbrick.com/). ## Setting Up¶ This section explains how to configure a direct connection in DBeaver and set up secure connections using SSH, proxies, SSL, and other available [network configurations](../Network-configuration/). ## Yellowbrick connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Yellowbrick database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Yellowbrick database. 1. The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/yellowbrick/yellowbrick-connection-main.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **URL** | If you are connecting via URL, enter the URL of your Yellowbrick database here. This field is hidden if you are connecting via the host. **Host** | If you are connecting via host, enter the host address of your Yellowbrick database here. **Database** | Enter the name of the Yellowbrick database you want to connect to. **Show all databases** | (Enabled by default) Displays all databases in the [database navigator](../Database-Navigator/). **Note** : This option works only when the **Host** connection type is selected. It does not work when connecting via **URL**. **Port** | Enter the port number for your Yellowbrick database. The default Yellowbrick port is `5432`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) \- [PgPass Authentication](../Authentication-PostgreSQL-Pgpass/) \- [SSPI Authentication (Windows SSO)](../Authentication-PostgreSQL-SSPI/) ![](../images/commercial.png) \- Yellowbrick OAuth2 ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The **Advanced** tab of the connection settings offers additional options that allow you to customize your further connection to the Yellowbrick database. ![](../images/database/yellowbrick/yellowbrick-connection-advanced.png) Field | Description ---|--- **Session Role** | This option allows you to define a specific role that your database session assumes upon connection. Setting a session role can be useful for managing permissions and access control within your Yellowbrick database. **Local Client** | Specify the local client, see our article about [local client configuration](../Local-Client-Configuration/). **Show template databases** | Displays template databases. This option is available when **Show all databases** is checked. **Show databases unavailable for connection** | Show databases not available for connection in database list. This option is available when **Show all databases** is checked. **Show databases statistics** | Displays statistics for databases. **Read all data types** | Reads all data types from the server (including arrays). **Read table keys with columns** | Enable reading table constraints during the column reading stage to ensure accurate recognition of keys. Note that this setting may decrease metadata loading performance. **Replace legacy timezone** | Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like **Europe/Kyiv** or **Asia/Calcutta**. Only these two timezones are affected. **Show`$$` quote as** | Displays `$$` quotes as code blocks or strings. **Show`$tagName$` quote as** | Displays `$tagName$` quotes as code blocks or strings. ### Connection details¶ The **Connection Details** section in DBeaver allows for further customization of your Yellowbrick connection. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ## Yellowbrick driver properties¶ The settings for Yellowbrick **Driver properties** enable you to adjust the performance of the Yellowbrick JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Yellowbrick database. You can customize the Yellowbrick driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Yellowbrick database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ## Secure Connection Configurations¶ DBeaver supports secure connections to your Yellowbrick database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Yellowbrick with DBeaver¶ DBeaver provides a host of features designed for Yellowbrick databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations. ## Yellowbrick database objects¶ DBeaver lets you view and manipulate a wide range of Yellowbrick database objects. DBeaver has extensive support for various Yellowbrick metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Tables * Columns * Constraints * Foreign Keys * Foreign Tables * Views * Materialized Views * Sequences * Data types * Aggregate functions * Extensions * Storage * Tablespaces * Roles * Administer * Jobs * Session Manager * Lock Manager ## Yellowbrick features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also supports advanced features available in Yellowbrick, many of which extend PostgreSQL compatibility. These include: Category | Feature ---|--- Data types | Support for arrays, ranges, network, JSON, and GIS-style types (`geography`, etc.) Extensions | Built-in support for extensions like `pgcrypto`, `plpgsql`, `plpythonu` Collations | Wide range of locale-based collations (`C`, `POSIX`, `utf8`, regional variants) Storage | Tablespaces management (`pg_default`, `pg_global`) Additional features compatible with Yellowbrick, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Lock Management | [Lock Manager](../Lock-Manager/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Database-drivers/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * Database drivers [ Database drivers ](./) Table of contents * JDBC and ODBC * Related articles * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * JDBC and ODBC * Related articles 1. [DBeaver](/docs/dbeaver) 2. Databases support # Databases support¶ DBeaver uses database drivers to connect to different databases. Drivers are small components that translate application requests into database-specific commands. Most drivers are bundled or can be downloaded automatically. If a driver is missing, you can add it manually using the [Driver Manager](../Driver-Manager/). DBeaver works with a wide range of databases: * **SQL databases** \- PostgreSQL, MySQL, MariaDB, Oracle, SQL Server, DB2, SQLite, Firebird, H2, and more * **NoSQL databases** \- MongoDB, Cassandra, Redis, DynamoDB, etc. * **Cloud services** \- Amazon RDS, Aurora, Google Cloud Spanner, Snowflake, BigQuery, and others * **Analytics platforms** \- ClickHouse, Vertica, Greenplum, Redshift, and more Info For details, see the list of supported databases for your edition: * [Lite Edition](../Lite-Edition/) * [Enterprise Edition](../Enterprise-Edition/) * [Ultimate Edition](../Ultimate-Edition/) You can also use [Cloud Explorer](../Cloud-Explorer/) to browse and manage cloud resources like AWS, Google Cloud, and Azure directly in DBeaver. ## JDBC and ODBC¶ By default, DBeaver uses **JDBC drivers** , which are Java libraries (`.jar` files). Lite, Enterprise, and Ultimate editions also support **ODBC drivers**. Info For details, see [ODBC driver](../ODBC-JDBC-Driver/). ## Related articles¶ * [Driver Manager](../Driver-Manager/) \- how to add or configure drivers manually * [ODBC driver](../ODBC-JDBC-Driver/) \- using ODBC with DBeaver * [FAQ](../FAQ/) \- common questions about connections and drivers * [Log files](../Log-files/) \- where to find logs for troubleshooting Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Deprecated-legacy-ODBC-driver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * Deprecated legacy ODBC driver [ Deprecated legacy ODBC driver ](./) Table of contents * How to connect via ODBC * Use ODBC driver in PRO versions * Download Legacy ODBC from GitHub * Use a third-party ODBC driver * How to transfer connections from the old ODBC to the new one in the Community version * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How to connect via ODBC * Use ODBC driver in PRO versions * Download Legacy ODBC from GitHub * Use a third-party ODBC driver * How to transfer connections from the old ODBC to the new one in the Community version 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Driver settings # Deprecated legacy ODBC driver The Legacy ODBC driver was removed in DBeaver Community Edition **23.1**. **Why was it removed?** * DBeaver users have encountered many issues with the outdated ODBC driver related to old drivers, which cannot be fixed by the DBeaver team. * This ODBC driver is based on the obsolete Java version 7. * It does not work on Linux and macOS, and that cannot be improved. ## How to connect via ODBC¶ If you want to connect to the databases via ODBC, you have the following options: ### Use ODBC driver in PRO versions¶ The new ODBC JDBC driver developed by the DBeaver team supports most new database drivers, works on Linux and macOS, and will be supported by the DBeaver team. [Learn more about the PRO ODBC driver](../ODBC-JDBC-Driver/) ### Download Legacy ODBC from GitHub¶ This driver is deprecated and not recommended for use because of many issues. It is based on Java 7, which prevents us from improving it. The DBeaver team does not support this driver and is not responsible for its work, but you can use it at your own risk. [Download the legacy ODBC driver](https://github.com/dbeaver/jdbc-odbc-bridge- jre7) ### Use a third-party ODBC driver¶ You can look for another ODBC driver that matches your database and try to use it. Follow this instruction to add a driver in DBeaver and configure it. [How to add a driver in DBeaver](../Driver-Manager/#add-a-new-driver) ## How to transfer connections from the old ODBC to the new one in the Community version¶ If you have been using the legacy ODBC driver in DBeaver Community and have some connections associated with it, you need to do the following: 1. Install the new ODBC driver that you want to use instead of the legacy one (legacy ODBC from GitHub or third-party ODBC). 2. Re-associate the old connections: select such connections, go to Database -> Change Connection(s) Driver, and find the newly installed ODBC. Another option is to remove the old connections created with the legacy ODBC driver and create new connections associated with the newly installed ODBC. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Differences-between-license-types/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * License types [ License types ](./) Table of contents * License comparison * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * License comparison 1. [DBeaver](/docs/dbeaver) 2. [Licenses](/docs/dbeaver/How-to-Import-License) 3. License types # License types DBeaver offers different license types. Use the table below to compare license types, support availability, and limitations. ## License comparison¶ | Individual Yearly subscription | Group Yearly subscription | Perpetual (Discontinued after version `23.3`) | Individual Monthly subscription | [Early Access Program](../Early-Access-Program-license/) (EAP) | Academic | Trial ---|---|---|---|---|---|---|--- **Product availability** | [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) | [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) | [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) | [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) | [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) | [Enterprise](../Enterprise-Edition/) | [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) **Duration of access** | 1 year | 1 year | 1 year from purchase | 1 month | 1 month from release | 1 year | 14 days **Access to[releases](../DBeaver-release-cycles/)** | Regular and Early Access | Regular and Early Access | Regular and Early Access | Regular and Early Access | Monthly EAP versions only | Regular and Early Access | All features during trial **Access blocked** | After expiration or failed renewal | After expiration or failed renewal | You can use the last available version indefinitely after expiration | After expiration or failed renewal | After expiration | | Access is blocked after the trial period is finished **Renewal** | Annual renewal | Annual renewal | Requires renewal to continue receiving product updates and support | Monthly renewal | Must manually download each new build | Requires re-request after expiration | Requires re-request for each new version, but only once per version **Support** | While the subscription is active | While the subscription is active | 1 year unless the license is renewed | While the subscription is active | Not available | Not available | While the trial period is active **Offline use** | Yes | Yes | Yes | No Requires online activation for the first activation and each renewal. | No | Yes | Yes **Limitations** | Per-user license: \- can be installed on multiple workstations if used by the same person; \- named-user only; \- server/VM use allowed | Named-user only; \- number of users fixed per license; \- installable on workstations, VMs, or servers with limited access for licensed users only | Per-user license: \- can be installed on multiple workstations if used by the same person; \- named-user only; \- server/VM use allowed | No | Limited to: \- 3 simultaneous DB connections \- 5 [automation tasks](../Task-Management/) (including composite) \- no [CLI](../Command-Line/) \- no [task scheduler](../Task-Scheduler/) \- 1 default [workspace](../Workspace-Location/) \- 1 default [project](../Projects/) | For students and teachers only. Not for commercial use | No limitations during trial period Important If a **Perpetual** license isn’t renewed within 90 days after expiration, it will be converted to an **Annual** subscription upon renewal. A warning will appear before completing the renewal. **Perpetual** licenses no longer allow installing versions released more than one year after the purchase date. To check your current license, go to [dbeaver profile](https://dbeaver.com/profile/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Disable-AI-assistance/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * Disable AI Assistant [ Disable AI Assistant ](./) Table of contents * Temporary disable * Permanent disable * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Temporary disable * Permanent disable 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. Settings # Disable AI Assistant ## Temporary disable¶ To turn off AI Assistant temporary: 1. Navigate to **Window - > Preferences -> General -> AI**. 2. Deselect **Enable AI integration**. ## Permanent disable¶ Admins can use this method to turn off AI Assistant by default during installation. Once this feature is permanently disabled, it cannot be re- enabled via **Preferences**. To turn off AI Assistant permanently: * Use the system variable by setting `DBEAVER_AI_DISABLED` to `true`. * Or, add `-Dai.disabled=true` to the `dbeaver.ini` file. Tip Detailed instructions on finding `dbeaver.ini` are available in [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Disconnect-from-Database/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * Disconnect from database [ Disconnect from database ](./) Table of contents * Disconnect from Database * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Disconnect from Database 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Disconnect from database ## Disconnect from Database¶ You might need to disconnect from a database to free up resources or close transactions. To disconnect from a database, click the connection in the [Database Navigator](../Database-Navigator/) or [Projects](../Projects/) view, and then click the Disconnect button in the toolbar or click **Database - > Disconnect** on the main menu: ![](../images/ug/Disconnect-from-DB.png) You can also right-click the connection and click **Disconnect** on the context menu. Note The Disconnect button and menu items are available only for those connections that are activated, that is, marked with the connected sign: ![](../images/ug/DB-icon-connected.png). When DBeaver disconnects from a database, its icon changes to its original state (not connected), for example, ![](../images/ug/DB-icon-not- connected.png) for PostgreSQL database. To disconnect from all active connections, click **Database - > Disconnect All** on the main menu. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Driver-Manager/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * Driver manager [ Driver manager ](./) Table of contents * Obtaining a JDBC driver * Driver Manager * Add a new driver * Main parameters * Generic driver * URL template * Libraries * Maven artifacts * Driver properties * Advanced parameters * Main parameters * Queries * DDL * Formatting * Saving the driver and adding a connection * Edit driver * Change connection driver * Update driver manually * Update driver automatically * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Obtaining a JDBC driver * Driver Manager * Add a new driver * Main parameters * Generic driver * URL template * Libraries * Maven artifacts * Driver properties * Advanced parameters * Main parameters * Queries * DDL * Formatting * Saving the driver and adding a connection * Edit driver * Change connection driver * Update driver manually * Update driver automatically 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Driver settings # Driver manager DBeaver supports many types of databases, including SQL, NoSQL, and others, by using pre-configured drivers to establish connections. If a specific database is not supported by default, you can manually add its JDBC driver through the Driver Manager. Tip DBeaver also supports ODBC drivers for users who prefer this standard. For more information on integrating ODBC drivers, see [ODBC driver](../ODBC-JDBC- Driver/). ## Obtaining a JDBC driver¶ A JDBC driver is a Java library that lets you connect and work with a specific database. It includes everything needed to use all the features of the database. These drivers are usually provided by the companies that create the databases. JDBC drivers are made up of one or more `.jar` files. These files contain the code and other important files needed to use the driver. To add a new driver to DBeaver, you first need to get these `.jar` files. You can find them included with your database server or download them from the database provider’s website. If you are not sure where to find them, ask your database administrator. ## Driver Manager¶ To begin adding a new JDBC driver, first open the Driver Manager. You can find it by navigating to **Databases - > Driver Manager** from the main menu. ![](../images/ug/drivers/driver-manager-view.png) Button | Description ---|--- **New** | Creates a new driver configuration. **Copy** | Copies the selected driver configuration. **Edit...** | Opens the selected driver configuration for editing. **Delete** | Removes the selected driver configuration from DBeaver. **Un-delete** | Restores recently deleted driver configurations. ### Add a new driver¶ Click the **New** button to start adding a new driver. In the driver edit dialog, you will need to fill all the necessary details to configure the driver. ### Main parameters¶ ![](../images/ug/drivers/driver-manager-settings.png) Parameter | Description ---|--- **Driver Name** | The name you assign to the driver. This can be any descriptive name that helps you identify the driver among others. **Driver Type** | Specifies the type of the driver used for connecting to the database. Users typically select the appropriate driver type based on the database being connected to. For unsupported databases, the **Generic** type is often used. For more information see section below. **Class Name** | The fully qualified name of the Java class for the JDBC driver. This is the main class that Java uses to interact with the database. It can often be found in the driver's documentation or by inspecting the `.jar` file. **URL Template** | A template for the database connection URL. If left empty, you must specify the JDBC URL manually for each connection. It's recommended to provide a template to simplify connection setup. For more information see section below. **Default Port** | The port number typically used by the database. This is optional and can be left blank if the port is non-standard or varies between installations. **Embedded** | Check this option if the database runs embedded within an application. This setting adjusts network and connection management configurations accordingly. **No Authentication** | Indicates that the driver does not use authentication. If selected, user and password input fields will be hidden in connection dialogs. **Category** | Used to group drivers within DBeaver. This field is deprecated but may still appear in some versions of the software. **ID** | A system-generated unique identifier for the driver. This is usually auto-filled. **Description** | A brief description of the driver. ### Generic driver¶ The **Generic** driver allows you to connect to databases that do not have a predefined JDBC driver. It works with any database that supports JDBC, giving you control to manually load the required JDBC library. This driver is useful for connecting to custom or uncommon databases. It ensures flexibility in setting connection parameters, but you must ensure that the JDBC driver you provide is fully compatible with the database to avoid issues with connections or queries. ### URL template¶ JDBC drivers use URLs to connect to databases, similar to web URLs. These URLs typically follow the format `jdbc:vendor:host:port/database`. For example, a PostgreSQL database might use `jdbc:postgresql:localhost:5432/postgres`. Directly editing these long and complex strings can be prone to errors and inconvenient. DBeaver simplifies this process by constructing the URL from connection parameters like host, port, and database name, which you provide on the connection configuration page. For the example mentioned, the URL template would be: `jdbc:postgresql://{host}:{port}/{database}` Info For more information on the available variables, see [Pre-configured variables](../Pre-configured-Variables/). ### Libraries¶ The Libraries tab displays a list of `.jar` files, binary libraries (such as `.dll` or `.so` files), and other files necessary for the driver. Typically, you only need to add `.jar` files here. ![](../images/ug/drivers/driver-manager-libraries.png) Button | Description ---|--- **Add File** | Adds a single `.jar` file. Useful for including individual JDBC driver files or additional libraries needed. **Add Folder** | Adds an entire directory that contains Java classes or resources, facilitating bulk additions. **Add Artifact** | Allows for the inclusion of a Maven artifact directly, streamlining dependency management for users who utilize Maven. For more information see the section below. **Edit...** | Allows you to modify the selected file or folder properties. **Delete** | Enables you to remove a selected file or folder from the list. **Download/Update** | Allows for the downloading or updating of the selected library file or artifact. **Information** | Provides detailed information about the selected file or artifact, such as version, source, and dependencies. **Find Class** | Searches the added `.jar` files for JDBC driver classes and displays all found classes, enabling you to select the correct one for your configuration. **Classpath** | Displays the full classpath constructed from the added files and folders, useful for debugging or verification purposes. Once you have added the necessary `.jar` files, you can locate the JDBC driver classes contained within these files. Click the **Find Class** button, and DBeaver will list all available driver classes found in the added `.jars`. Usually, there is only one driver class per driver, but if multiple classes are listed, you should consult the driver's documentation to identify the correct one. #### Maven artifacts¶ DBeaver can download driver `.jars` from the Maven repository, a global collection of Java libraries. If your database driver is listed in this public repository, you can use this feature. Maven artifacts are useful because they let you see all driver versions and change the driver version during runtime without reconfiguring driver properties. Info For additional information, see [How to add additional artifacts to the driver](../How-to-add-additional-artifacts-to-the-driver/). ### Driver properties¶ The Driver Properties tab displays default connection properties related to the JDBC driver once a driver file is loaded. This tab allows for the configuration and customization of various driver-specific settings necessary for establishing and managing database connections. ![](../images/ug/drivers/driver-manager-properties.png) ### Advanced parameters¶ For most JDBC drivers, the default advanced properties suffice. However, you may find it beneficial to adjust these settings for performance optimization or to correct structural issues. ![](../images/ug/drivers/driver-manager-advanced-parameters.png) #### Main parameters¶ Parameter | Description ---|--- **Driver supports indexes** | Indicates if the driver can utilize table indexes. **Driver supports stored code** | Supports stored database objects like procedures, functions, and packages. **Driver supports references** | Allows the driver to handle table references such as foreign keys. **Driver supports SELECT count(*) clause** | Supports the use of the SELECT count(*) SQL clause. **Driver supports views** | Enables the driver to manage table views. **Split procedures and functions** | Displays procedures and functions in separate folders in the UI. **Script delimiter** | Character or string used to separate SQL statements in scripts. **Script delimiter redefiner** | SQL clause that changes the script delimiter during execution. **Use script delimiter after query** | Retains the delimiter after each SQL query within scripts. **Use script delimiter after SQL block** | Maintains the delimiter after SQL blocks like `BEGIN/END`. **String escape character** | Character used to escape special characters in SQL strings. **Meta model type** | Defines the metadata model type, either standard or indexed. **All Objects Pattern** | SQL pattern to match all metadata objects. **Omit catalog(s)** | Skips catalog (database) information in metadata operations. **Omit single catalog** | Hides catalog in the UI if only one exists on the server. **Omit schema(s)** | Omits reading schema information from metadata. **Omit single schema** | Hides schema in the UI if only one exists. **Use schema filters** | Applies JDBC schema filters for databases not supporting catalogs, or filters schemas client-side. **Omit type cache** | Avoids using the driver's internal cache for data types. **Shutdown parameter** | Parameter for shutting down the database through URL. **Create database parameter** | URL parameter used to create a new database. **Driver supports multiple results** | Supports multiple result sets per query. **Driver supports result set limit** | Allows setting limits on the number of rows in a result set. **Driver supports structure cache** | Uses cache for database structure such as columns and keys. **Driver supports TRUNCATE operation** | Enables use of the `TRUNCATE` command, faster than using `DELETE`. #### Queries¶ Parameter | Description ---|--- **Get active database** | Retrieves the name of the currently active database. **Set active database** | Sets the active database during the session. **Shutdown database** | Command to shut down the active database connection. **PING query** | SQL query to check the connection state. **Dual table name** | Specifies the name of a dummy table used for evaluating expressions. **Active object type** | Defines the type of database object that can be selected (e.g., schema, catalog). **Driver supports results scrolling** | Enables scrolling through results in the result set. **Quote reserved words** | Automatically quotes SQL reserved words when they conflict with identifier names. **Escape LIKE masks in search queries** | Escapes special characters in `LIKE` clauses during metadata searches. #### DDL¶ Parameter | Description ---|--- **Drop column short syntax** | Uses a shorter syntax for dropping columns. **Drop column - use brackets** | Encloses column names in brackets when dropping. **Use legacy SQL dialect for DDL** | Uses a traditional SQL dialect for DDL operations. **Add COLUMN keyword in alter table query** | Adds the `COLUMN` keyword in `ALTER TABLE` queries for clarity. #### Formatting¶ Parameter | Description ---|--- **Timestamp format** | The format pattern for timestamp columns. **Date format** | The format pattern for date columns. **Time format** | The format pattern for time columns. Info For more information on a date/time format pattern, see [DateTimeFormatter documentation](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#patterns). ### Saving the driver and adding a connection¶ Once you have completed configuring your driver, click the **Ok** button to save the settings. You are now ready to [Create a connection](../Create- Connection/). ## Edit driver¶ Editing an existing driver can be done through several access points: * **Driver Manager** : Navigate through **Databases - > Driver Manager** in the main menu to edit any listed driver. * **Database Navigator** : Right-click on a database connection to open the context menu, then select **Edit Connection** to open the [**Connection Properties** dialog](../Create-Connection/#configuring-connection-settings). This method allows you to modify the driver settings linked specifically to that connection. ### Change connection driver¶ You can change the driver version for an existing connection: 1. Select a connection in the [Database Navigator](../Database-Navigator/). 2. Go to **Database** in the [Menu bar](../Application-Window-Overview/#menu-bar). 3. Click **Change connection(s) driver** , then select a different driver. ![](../images/ug/drivers/change-connection-driver.png) Note DBeaver uses two types of drivers: built-in and downloadable (Maven-based). You can only change the version for downloadable drivers. To update a built-in driver, update it manually. ### Update driver manually¶ To update a driver version manually: 1. In [Database Navigator](../Database-Navigator/), right-click your connection. 2. Click **Edit Connection**. 3. In the window that opens, click **Driver Settings**. 4. Go to the **Libraries** tab. 5. Double-click the driver file - this opens its folder. Info If there’s no driver listed (for example, you deleted it), click **Add File** or **Add Folder** , then select the driver file manually. 6. Replace the file with the new version. You need to download the `.jar` file manually. Sources vary depending on the driver: * **Official vendor site** \- some drivers are only available on the database vendor’s site. * **GitHub releases** \- many open-source drivers publish binaries in the **Releases** section. * **Maven Central** \- some drivers are available at [search.maven.org](https://search.maven.org). * **Other public repositories** \- some projects host drivers on project-specific sites or custom registries. Tip You don’t need to delete the whole folder - just replace or remove old `.jar` files to avoid conflicts. 7. Click **OK** , then **Test Connection** to verify it works. ### Update driver automatically¶ You can configure your drivers to update automatically on startup. 1. Go to **Window - > Preferences -> Connections -> Drivers**. ![](../images/ug/drivers/update-driver-automatically.png) 2. Configure driver-related settings: Setting | Description ---|--- **Check for new driver versions** | Automatically checks for driver updates when DBeaver starts. **Proxy Host** | Hostname of the proxy server used for driver downloads. **Proxy Port** | Port number for the proxy. **User** | Username for proxy authentication (if needed). **Password** | Password for proxy authentication. **Local folder** | Local folder where downloaded drivers are stored. You can specify a custom directory. **File repositories** | URLs of remote repositories used for downloading drivers. 3. Click **Apply and Close**. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/ER-Diagrams/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * ER Diagrams [ ER Diagrams ](./) Table of contents * Selection of Elements in Diagrams * Generate SQL * Structure Adjustment * View Adjustment * Refresh * Diagram Notations and Routing types * Notations * Routing types * Setting Notation and Routing type * Notes * Search in Diagram Entities * Bindings * Navigation and selection * Table Manipulation * Focus * Other Functions * Diagram Export * Diagram Printing * Settings * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Selection of Elements in Diagrams * Generate SQL * Structure Adjustment * View Adjustment * Refresh * Diagram Notations and Routing types * Notations * Routing types * Setting Notation and Routing type * Notes * Search in Diagram Entities * Bindings * Navigation and selection * Table Manipulation * Focus * Other Functions * Diagram Export * Diagram Printing * Settings 1. [DBeaver](/docs/dbeaver) 2. Entity relation diagrams # ER Diagrams When you open the **Diagrams** tab of the [Database Object Editor](../Database-Object-Editor/), you can visually explore, analyze, and customize your database structure. The interface includes: * **Diagrams editor** : View and rearrange entities and their relationships. * **Palette panel** : Access tools for adding connections, notes, and more. * **Toolbar** : Manage diagrams with options for saving, exporting, zooming, and configuration. DBeaver supports diagrams for existing tables, schemas, and custom visualizations. You can select, modify, and customize elements or export diagrams for further use. Advanced notations, routing types, and certain features may depend on your product edition. For more, see [Database Structure Diagrams](../Database-Structure-Diagrams/). Tip Create custom diagrams to tailor visualizations. See [Custom Diagrams](../Custom-Diagrams/). ## Selection of Elements in Diagrams¶ You can use one of the two tools to select elements in diagrams: * Select – supports both, single and multi-select modes. To select a single element (table, connection, entity inside a table) in a diagram, just click that element. To select multiple elements, similar to using the Marquee tool, click outside the first element and draw until all elements you need are in focus: ![](../images/ug/ERD-Select-tool.png) ## Generate SQL¶ Diagrams in DBeaver support generating SQL for various commands, including `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `MERGE`, `JOIN`, and some database- specific commands such as `INSERT ON CONFLICT`, `UPDATE FROM`, and `DELETE USING`. Tip `INSERT ON CONFLICT`, `UPDATE FROM`, and `DELETE USING` are specific to PostgreSQL. * Right-click the selected tables and choose **Generate SQL** to create the query automatically. * To generate a **JOIN** statement, select multiple tables in the diagram. ## Structure Adjustment¶ Note All changes to existing database schemas cannot be saved and are intended for exploration purposes only. You can do the following structural changes in the diagrams. * Add new tables to a diagram by drag-n-dropping them onto the diagram field from the [Database Navigator](../Database-Navigator/). * Rearrange tables in the diagram by dragging them all over the space. You can select several tables and drag them to a new location. * Auto-arrange tables into a compact view after manual rearrangements: click the **Arrange Diagram** (![](../images/ug/Arrange-diagrams.png)) in the toolbar or on the context menu (right-click anywhere on the diagram tab). * (Available for [Custom Diagrams](../Custom-Diagrams/) only) - connect tables with a connector: click the **Show Palette** button (![](../images/ug/Show-pallette-icon.png)) in the upper-left corner of the diagram tab and then, in the Palette panel, click **Connection** : ![](../images/ug/ERD-Connections.png) Now click the tables that you want to connect with each other in turn, one by one. To stop the connection line, double-click the last table * (Available for [Custom Diagrams](../Custom-Diagrams/) only) - removes tables and connections: right-click the table or connection and click **Delete** on the context menu or just click the table or connection and press `Delete`. Tip In cases where tables lack actual foreign keys, dragging one column onto another allows you to set up a [virtual foreign key](../Virtual- Keys/#creating-a-virtual-foreign-key). This can be useful for managing data relationships in environments where physical constraints are not defined. ## View Adjustment¶ You can adjust the view of any diagram in the following ways: * Enable/disable the diagram grid: Click **Toggle Grid** (![](../images/ug/Toggle-grid.png)) in the toolbar. * Modify attributes visibility: Right-click the diagram and, on the context menu, click **Show Attributes** and then select one of the options: * **All** \- all attributes * **Any keys** \- primary and foreign keys * **Primary key** \- only primary keys * **None** \- no attributes * Modify attributes presentation: Right-click the diagram and, on the context menu, click **View Styles** and then select one of the options: * **Show Icons** * **Show Data Types** * **Show Nullability** * **Show Comments** * **Show Fully qualified names** * Change the color of the entities/notes: Right-click the header of the entity or comment and then click **Set color** on the context menu. Then you can select the color and click **OK**. * For elements located in front of/behind others, bring an element to the front or send it to the back: Right-click the element and then click **Bring to front** / **Send to back** on the context menu. * Zoom the diagram in/out: Click the **Zoom In** /**Zoom Out** buttons or choose the scaling value in the dropdown list in the toolbar: ![](../images/ug/ERD-zoom.png) ## Refresh¶ To see changes made by others to the database schema, you might need to refresh the diagram: click **Refresh Diagram** (![](../images/ug/Refresh- projects-icon.png)) in the toolbar. ## Diagram Notations and Routing types¶ DBeaver offers a variety of notations and routing types for Diagrams, allowing you to customize database structure representations to suit your needs. ### Notations¶ * **IDEF1X** (default): Highly recommended for designing relational databases. It places a strong emphasis on detailing entity relationships and constraints. For more information, see [IDEF1X Notation](https://www.softwaregems.com.au/Documents/Documentary%20Examples/IDEF1X%20Notation.pdf). ![](../images/ug/1DEF1X-notation-sample.png) * **Bachman** : A notation that is particularly useful for data processing diagrams and reflects the data structure of the designed system from the data management perspective. For a more detailed understanding, refer to [Bachman Notation](https://www.conceptdraw.com/examples/bachman-notation). ![](../images/ug/Bachman-notation-sample.png) Note Bachman notation is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/dbeaver-team- edition) editions only. * **Crow's Foot** : This notation is widely used and is particularly intuitive for representing cardinality and relationships between entities. More information is available on [Crow's Foot Notation](https://miro.com/diagramming/crows-foot-notation-in-er-diagrams/). ![](../images/ug/Crows-foot-notation-sample.png) ### Routing types¶ * **Shortest paths** (default): Calculate and display the shortest possible lines connecting entities, ensuring a compact and efficient diagram representation. ![](../images/ug/Shortest-paths-router-sample.png) Tip Click on a connection to view detailed relationships. * **Orthogonal paths** : Uses right-angled lines for clear, structured layouts; Showing direct relationships between tables and columns. ![](../images/ug/Orthogonal-paths-router-sample.png) Note Orthogonal paths are available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/dbeaver-team- edition) editions only. ### Setting Notation and Routing type¶ To set notation or routing type in an Diagram: 1. Right-click on an empty space within the Diagram area. 2. From the context menu, hover over **Notation** or **Routing** for the respective settings. 3. Select your preferred option from the submenu. Alternatively, adjust these settings through the Diagram toolbar: 1. Click the **Settings** button ![](../images/ug/Configure-columns-visibility-icon.png). 2. In the **Advanced** section, find the **Notation type** or **Routing type** dropdown menu. 3. Choose your preferred setting. ## Notes¶ You can create notes only in [Custom Diagrams](../Custom-Diagrams/). To create a note, click the **Show Palette** button (![](../images/ug/Show-pallette- icon.png)) in the upper-left corner of the diagram tab. Then, in the Palette panel, click **Note** and click anywhere in the diagram tab. Now you can double-click the **Note** box to enter the note text: ![](../images/ug/ERD-Notes.png) ## Search in Diagram Entities¶ To search among entities of a diagram, click the **Search items** button (![](../images/ug/Search-icon.png)) in the toolbar, then type in the search combination. The entities that contain the search combination are highlighted in the diagram. To remove the filter, click the cross icon next to the search field. ## Bindings¶ ### Navigation and selection¶ * Use `ARROWS` to navigate between tables. * Press `SHIFT`|`⇧` \+ `ARROWS` to select multiple tables. * Press `CTRL`|`⌃` \+ `ARROWS` to select additional tables using `SPACEBAR`. * Press `SPACEBAR` to select the current table. ### Table Manipulation¶ * Press `.` (period) to change the mode to move/resize tables, then use `ARROWS` and `ENTER`|`↩` to move/resize tables. Note To use this feature on macOS, you may need to enable accessibility permissions for DBeaver. This can be done in `System Preferences -> Security & Privacy -> Accessibility`. ### Focus¶ * Press `ENTER`|`↩` to focus on attributes in the table. * Press `BACKSPACE`|`⌫` to leave the focus. * Use `|`, `?`, `\` to focus on associations. * Press `ALT/FN + 1`|`⌥/FN + 1` to focus on the diagram. * Press `ALT/FN + 2`|`⌥/FN + 2` to focus on the palette. * Press `ALT/FN + 3`|`⌥/FN + 3` to focus/open the outline. * Press `ALT/FN + 4`|`⌥/FN + 4` to focus on the parameter view. ### Other Functions¶ * Press `CTRL + SHIFT + ENTER` |`⌃ + SHIFT + ↩` to open the selected table diagram. ## Diagram Export¶ You can export (save) a diagram as an image (PNG, GIF, BMP formats) or as a file in GraphML format. To export a diagram, click **Save diagram in external format** (![](../images/ug/ERD-Export.png)) in the toolbar. ## Diagram Printing¶ To print a diagram, press `CTRL+P` or click **Print Diagram** (![](../images/ug/Print-icon.png)) on the toolbar. ## Settings¶ To modify the diagram settings, click **Configuration** (![](../images/ug/Configure-columns-visibility-icon.png)) on the toolbar. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Early-Access-Program-license/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * Early Access Program (EAP) license [ Early Access Program (EAP) license ](./) Table of contents * How it works * Terms * Restrictions * How to leave the program * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How it works * Terms * Restrictions * How to leave the program 1. [DBeaver](/docs/dbeaver) 2. [Licenses](/docs/dbeaver/How-to-Import-License) 3. License types # Early Access Program (EAP) license The Early Access Program (EAP) license lets you use and test pre-release builds of DBeaver [Lite](../Lite-Edition/), [Enterprise](../Enterprise- Edition/), or [Ultimate](../Ultimate-Edition/) Edition for free. Important Early Access builds may include new or unfinished features and can be unstable. Please use EAP builds at your own risk. ## How it works¶ You can join the Early Access Program directly in DBeaver once your trial license expires. After joining, you’ll get a special license key that works only with Early Access builds. ![](../images/license/Early-Access-Program-License-expire.png) Participation in the program has no time limit as long as you follow the restrictions. DBeaver may change or stop the program at any time without prior notice. Before you start, please review the main terms and limitations below: ### Terms¶ By joining the Early Access Program, you agree to the following: * **Non-commercial use only** \- EAP builds are provided not for commercial use. * **Anonymous[statistics collection](../Statistics-Collection/)** \- DBeaver collects basic anonymous data to improve the product. ### Restrictions¶ The Early Access Program license comes with several limitations: * **3 database[connections](../Create-Connection/)** \- you can have only three simultaneous connections. If more are configured, the app won’t start until you remove the extra ones. * **5[tasks](../Task-Management/)** \- you can create and run up to five simultaneous tasks. For composite tasks, both the composite task and its components are counted. * **No[CLI](../Command-Line/)** \- command-line execution is not available. * **No[task scheduler](../Task-Scheduler/)** \- you can’t schedule tasks to run automatically. * **One default[workspace](../Workspace-Location/)** \- DBeaver runs only with the default workspace. * **One default[project](../Projects/)** \- DBeaver runs only with the default project. Note Each Early Access build works for one month from its creation date. After that, you’ll need to download a new build from the [DBeaver website](https://dbeaver.com/files/ea/). ## How to leave the program¶ You can leave the Early Access Program at any time by: * uninstalling the Early Access version, or * buying and [importing a regular subscription license](../How-to-Import-License/) key into DBeaver. Info Learn more about [license types](../Differences-between-license-types/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Eclipse-extensions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * Eclipse extensions [ Eclipse extensions ](./) Table of contents * Install process * Extensions * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Install process * Extensions 1. [DBeaver](/docs/dbeaver) 2. Integrated tools # Eclipse extensions Built on Eclipse, DBeaver lets you install additional extensions (plugins), including those developed specifically for DBeaver. ## Install process¶ Tip You can also install Eclipse extensions from the command line using the built- in p2 Director Application. For details, see [Install Eclipse extensions from the command line](../Command-Line/#install-eclipse-extensions). 1. Open `Help -> Install New Software` 2. Choose the extension from the dropdown or paste the extension P2 repository URL into the **Work with** field and press `Enter` ![](../images/choose-the-extension.png) 3. Select the extensions you want to install ![](../images/darkest-dark-extension.png) 4. Click **Next - > Finish**, then restart DBeaver Important Installation may fail if DBeaver is in a write-protected folder (like `Program Files`, `/Applications`, or `/usr/`). Run DBeaver from a writable folder or as Administrator/root. ## Extensions¶ You can extend DBeaver with official and third-party Eclipse plugins. Some popular options: Extension | Description | Download link ---|---|--- **Office integration** | Export data in Office formats (`XLS`/`XLSX`). Works with MS Office, LibreOffice, OpenOffice, and macOS Numbers. | [Office](https://marketplace.eclipse.org/content/dbeaver-office-integration) **SQL debugger** | Adds SQL debugging support for PostgreSQL. [Learn more](../PGDebugger/) | [PGDebugger](https://marketplace.eclipse.org/content/dbeaver-sql-debugger) **Git integration** | Adds Git version control integration. [Learn more](../Project-team-work/) | [GIT support](https://marketplace.eclipse.org/content/dbeaver-git-support) **Darkest Dark theme** | Popular dark theme for Eclipse/DBeaver. | [Darkest Dark theme](https://marketplace.eclipse.org/content/darkest-dark-theme-devstyle) **Eclipse Color Theme** | Alternative theme set. | [Eclipse Color Theme](https://marketplace.eclipse.org/content/eclipse-color-theme) **Subversion (SVN)** | Version control integration. | [Subclipse](https://marketplace.eclipse.org/content/subclipse) **Embedded Shell** | Run shell commands directly from DBeaver. | [EasyShell](https://marketplace.eclipse.org/content/easyshell) **Editor vertical indents** | Adds vertical indent lines in editors. | [Indent Guide](https://marketplace.eclipse.org/content/indent-guide) **CodeTogether** | Collaborative coding and IDE sharing. | [CodeTogether](https://marketplace.eclipse.org/content/codetogether-cloud) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Edit-Connection/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * Edit connection [ Edit connection ](./) Table of contents * Edit connection * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Edit connection 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Edit connection ## Edit connection¶ To edit the configuration settings of a database connection, in the [Database Navigator](../Database-Navigator/) or in the [Projects](../Projects/) view, right-click the connection and click **Edit Connection** on the context menu. The Connection configuration window will open: ![SQLite2](https://github.com/dbeaver/dbeaver/assets/49681450/c903a47f-fa00-4d9b-8f17-68cbe11948a1) The navigation pane on the left displays the configuration sections, most of which are the same as those in the Create new connection wizard, see [Connect to Database](../Create-Connection/). There are additional configuration sections as well, such as **Result Sets** and **SQL Editor**. Click the section name to open the configuration settings for editing. You can test if your connection works with modified settings - click **Test Connection**. When you finish editing your connection, click **OK** to save the changes or **Cancel** to discard them. Driver settings: * In development [JDBC Time Zones](../JDBC-Time-Zones/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Edit-mode/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * Edit mode for diagrams [ Edit mode for diagrams ](./) Table of contents * Edit mode * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Edit mode 1. [DBeaver](/docs/dbeaver) 2. Entity relation diagrams # Edit mode for diagrams Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. ## Edit mode¶ Edit mode for Diagrams is a special feature that lets you create database objects while using the visual presentation of ER Diagrams. It can be accessed on the ERD tab of any database object that supports it. Changes made to a diagram in edit mode will generate an SQL script that can be executed to persist all the changes made. You can enable Edit mode by either choosing it from the context menu or by clicking a button on the bottom toolbar. To create an object you need to right-click on the diagram and select an object that you want to create. Foreign keys are created similarly to virtual foreign keys in custom diagrams. Just drag a column from a table for which the foreign key is being added and drop it in the referenced table. This will open a window that lets you choose a unique key in the referenced column. ![](../images/Edit_mode-create.png) Saving changes to a database is performed by clicking a save button. This will show you a preview of a generated script that you then can execute or cancel. The revert button will cancel all the changes that you did to a diagram after the last save. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Enterprise-Edition/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * Enterprise edition [ Enterprise edition ](./) Table of contents * Enterprise Edition features * Subscription model * Integrated database drivers * Supported databases * Relational databases * Non-Relational databases * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Enterprise Edition features * Subscription model * Integrated database drivers * Supported databases * Relational databases * Non-Relational databases 1. [DBeaver](/docs/dbeaver) 2. [About DBeaver](/docs/dbeaver/Enterprise-Edition) 3. Editions # Enterprise edition [DBeaver Enterprise Edition](https://dbeaver.com/dbeaver-enterprise/) is ideal for users who need a powerful set of tools for complex data environments. This edition goes beyond simple database tasks, enhancing data visualization, query development, security features, and administrative tasks. It is a vital tool for professionals looking to improve their productivity and manage data more effectively. Note The DBeaver Enterprise Edition is designed for individual use only. ## Enterprise Edition features¶ The Enterprise Edition provides specialized tools and features that cater to the needs of businesses: * **Data visualization** * **Data filtering and sorting** : Provides tools to filter and sort data directly within the database interface. [Learn more](../Data-Filters/). * **Color coding and highlighting** : Simplifies data analysis by color-coding and highlighting table rows and fields based on conditions. [Learn more](../SQL-Code-Editor/). * **Functional panels** : Enhance data manipulation by offering additional space in the Data Editor for managing complex data types, accessible via tabs in a dedicated panel. [Learn more](../Panels/). * **Tableau integration** : Facilitates integration with Tableau for advanced data visualization and analysis. [Learn more](../Tableau-integration-in-DBeaver/). * **Query development** * **SQL Editor** : Provides code completion for easier writing, auto-formatting, spelling checks, and support for variables. [Learn more](../SQL-Editor/). * **Execution plan visualization** : Provides detailed visualizations of SQL execution plans. [Learn more](../Query-Execution-Plan/). * **Additional tools for query creation** : * **Visual Query Builder (VQB)** : Provides a graphical interface to construct SQL queries without writing code. [Learn more](../Visual-Query-Builder/). * **AI Assistant** : Integrates an AI Assistant and AI Chat to offer guidance and automation within the SQL Editor. [Learn more](../AI-Smart-Assistance/). * **SQL debugger** : Offers an SQL debugger specifically designed for PostgreSQL, aiding in query development and troubleshooting. [Learn more](../PGDebugger/) * **Administrative tasks** * **Reverse engineering (ERD)** : Provides capabilities for reverse engineering databases into entity-relationship diagrams. [Learn more](../ER-Diagrams/). * **Forward engineering** : * **Metadata editor** : Enables the management and editing of database metadata. [Learn more](../Database-Object-Editor/). * **Edit mode for ER-Diagrams** : Offers functionalities for editing entity-relationship diagrams to aid in database design. [Learn more](../Edit-mode/). * **Administrative tools** : * **Backup and Restore** : Offers functionalities for backing up and restoring databases, ensuring data safety. [Learn more](../Backup-Restore/). * **Analyze and vacuum** : Tools for optimizing database performance by analyzing and vacuuming database objects. * **Permission and user management** : Manages database permissions and user accounts. * **Schema comparison** : Provides tools for comparing database schemas either within the same database or across different databases. [Learn more](../Data-compare/). * **Data comparison** : Offers tools for comparing data across databases or within different parts of the same database. [Learn more](../Schema-compare/). * **Mock data generator** : Provides tools for generating mock data, useful for testing and development purposes. [Learn more](../Mock-Data-Generation-in-DBeaver/). * **Data migration** * **Export and Import from files** : Supports data export and import in up to 10 different file formats. [Learn more](../Data-transfer/). * **Direct transfer between databases** : Provides tools for efficient data migration directly between different databases or systems. [Learn more](../Data-migration/). * **Security** * **Database authentication** : Implements database authentication mechanisms to secure access. * **Master and Project Password** : * **Master password** : Enables the use of a master password to enhance security across the DBeaver. [Learn more](../Managing-Master-Password/). * **Project password** : Facilitates the use of project-specific password to secure projects. [Learn more](../Project-security/). * **Automation** * **Task manager** : A tool for managing and monitoring database tasks, enhancing productivity and organization. [Learn more](../Task-Management/). * **Task scheduler** : Allows for scheduling database tasks, automating routine operations. [Learn more](../Task-Scheduler/). * **Git integration** : Supports integration with Git for version control, and change tracking. [Learn more](../Project-team-work/). ### Subscription model¶ The DBeaver Enterprise Edition is offered as an annual subscription, which should be renewed to continue receiving updates and support. [Discover more about the DBeaver Enterprise Edition and subscribe](https://dbeaver.com/dbeaver-lite/). ### Integrated database drivers¶ The Enterprise Edition has a comprehensive set of JDBC drivers, offering connectivity to various databases without needing separate downloads and configurations. Additionally, a versatile ODBC driver is supported for broader database compatibility. Info For additional details on utilizing the ODBC driver, please consult the [ODBC- JDBC driver](../ODBC-JDBC-Driver/) article. ### Supported databases¶ The Enterprise Edition provides support for a wide range of databases. Below are tables listing the databases available and specifying whether the Enterprise Edition offers enhanced features compared to the Community Edition. * Enhanced features may include additional metadata capabilities, such as the ability to manage and interact with specific database objects unique to certain systems. For instance, managing **Datashares** in Redshift or handling **Sequences** in Netezza. These features also cover various advanced authentication methods, and numerous other functionalities designed to improve security and data management. #### Relational databases¶ Database name | Enhanced features* compared to the Community Edition ---|--- **Altibase** | - **Apache Arrow** | Not available in Community Edition **Apache Calcite Avatica** | ✓ **Apache Kylin** | - **Aurora DSQL** | Not available in Community Edition **Azure SQL Server** | ✓ **Babelfish via TDS (beta)** | ✓ **CUBRID** | ✓ **Cache** | - [**ClickHouse**](../Clickhouse/) | - **CloudberryDB** | - [**ClickHouse (Legacy)**](../Clickhouse/) | ✓ [**CloudSQL - MySQL**](../Database-driver-MySQL-on-Google-Cloud/) | Not available in Community Edition [**CloudSQL - PostgreSQL**](../Database-driver-PostgreSQL-on-Google-Cloud/) | Not available in Community Edition [**CloudSQL - SQL Server**](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) | Not available in Community Edition **CockroachDB** | - **CrateDB** | - **CrateDB (Legacy)** | - [**Databricks**](../Database-driver-Databricks/) | ✓ **Dameng** | - [**Db2 for IBM i**](../Database-driver-IBM-Db2/) | ✓ [**Db2 for LUW**](../Database-driver-IBM-Db2/) | - [**Db2 for z/OS**](../Database-driver-IBM-Db2/) | ✓ **Denodo 8** | - **Derby Embedded** | - **Derby Server** | - **Dremio** | - **DuckDB** | - **EDB** | ✓ **Exasol** | ✓ **FerretDB** | Not available in Community Edition **Firebird** | ✓ **Fujitsu Enterprise Postgres** | Not available in Community Edition **GaussDB** | - [**Google AlloyDB**](../Database-driver-AlloyDB-for-PostgreSQL/) | Not available in Community Edition **Google Cloud Spanner** | ✓ [**Greenplum**](../Database-driver-Greenplum/) | ✓ **Greengage** | Not available in Community Edition **H2 Embedded** | ✓ **H2 Embedded V.2** | - **H2 Server** | ✓ **H2GIS Embedded** | - **H2GIS Server** | - **HANA** | ✓ **HSQL Embedded** | - **HSQL Server** | - **Informix** | ✓ **Ingres** | - **InterSystems IRIS** | - **JDBCX** | - **Jennifer** | - **MS Access (UCanAccess)** | - [**MariaDB**](../Database-driver-MariaDB/) | ✓ **Materialize** | - **MaxDB** | - **Mimer SQL** | - **MonetDB** | - [**MySQL**](../Database-driver-MySQL/) | ✓ [**MySQL 5 (Legacy)**](../Database-driver-MySQL/) | ✓ **NDB Cluster** | - **NetSuite** | Not available in Community Edition [**Netezza**](../Database-driver-Netezza/) | ✓ **NuoDB** | - **ODBC** | Not available in Community Edition **OceanBase** | - **Ocient** | - **OmniSci (formerly MapD)** | - **OpenEdge** | - **OpenSearch** | ✓ [**Oracle**](../Oracle/) | ✓ **Pervasive SQL** | - [**PostgreSQL**](../Database-driver-PostgreSQL/) | ✓ **PrestoDB** | - **PrestoSQL** | - **Raima** | Not available in Community Edition [**Redshift**](../Database-driver-Amazon-Redshift/) | ✓ [**Redshift Serverless**](../Database-driver-Amazon-Redshift/) | ✓ **RisingWave** | - **SAP ASE jConnect** | - [**SQL Server**](../Database-driver-Microsoft-SQL-Server/) | ✓ [**SQL Server (Old driver, jTDS)**](../Database-driver-Microsoft-SQL-Server/) | ✓ [**SQLite**](../Database-driver-SQLite/) | ✓ [**SQLite Crypt**](../Database-driver-SQLite/) | Not available in Community Edition **SQream DB** | - [**Salesforce**](../Database-driver-Salesforce/) | Not available in Community Edition **Salesforce Data Cloud** | ✓ **SingleStore** | ✓ [**Snowflake**](../Snowflake/) | ✓ **StarRocks** | - **Sybase jConnect** | ✓ **Sybase jTDS** | ✓ [**Teradata**](../Database-driver-Teradata/) | ✓ **TiDB** | - [**Trino**](../Database-driver-Trino/) | - **Vertica** | ✓ **Virtuoso** | - [**Yellowbrick**](../Database-driver-Yellowbrick/) | - **YugabyteDB** | - #### Non-Relational databases¶ Database name | Enhanced features* compared to the Community Edition ---|--- **Apache Drill** | ✓ [**Apache Hive**](../Apache-Hive/) | ✓ **Apache Ignite** | - **Apache Kyuubi** | - **Apache Phoenix** | - **Apache Spark** | - [**Athena**](../Database-driver-Amazon-Athena/) | ✓ **Azure Cosmos DB for Cassandra** | Not available in Community Edition [**Azure Cosmos DB for MongoDB**](../Database-driver-CosmosDB/) | Not available in Community Edition [**Azure Cosmos DB for NoSQL**](../Database-driver-Azure-CosmosDB-for-NoSQL/) | Not available in Community Edition [**Cassandra**](../Cassandra/) | Not available in Community Edition **Cloudera Impala** | - **CouchDB** | Not available in Community Edition [**Couchbase**](../Couchbase/) | Not available in Community Edition [**Couchbase 5+**](../Couchbase/) | Not available in Community Edition [**CSV**](../Database-driver-CSV/) | + **DBF** | - [**DocumentDB**](../AWS-DocumentDB/) | Not available in Community Edition [**DynamoDB**](../AWS-DynamoDB/) | Not available in Community Edition **Elasticsearch** | ✓ [**Firestore**](../Database-driver-Firestore/) | Not available in Community Edition **Gemfire XD** | - [**Google BigQuery**](../Database-driver-BigQuery/) | ✓ [**Google Cloud Bigtable**](../Google-Bigtable/) | Not available in Community Edition [**InfluxDB**](../InfluxDB/) | Not available in Community Edition [**InfluxDB 2**](../InfluxDB/) | Not available in Community Edition [**InfluxDB 3**](../InfluxDB/) | Not available in Community Edition [**Keyspaces**](../AWS-Keyspaces/) | Not available in Community Edition **Machbase** | - [**MongoDB**](../MongoDB/) | Not available in Community Edition [**Neo4j**](../Database-driver-Neo4j/) | Not available in Community Edition [**Neptune**](../Database-driver-Neptune/) | Not available in Community Edition **Open Distro Elasticsearch** | ✓ **OrientDB** | - [**Parquet**](../Database-driver-Parquet/) | Not available in Community Edition [**Redis**](../Redis/) | Not available in Community Edition **ScyllaDB** | Not available in Community Edition **SnappyData** | - **Solr** | - **TDengine** | ✓ **TDengine Cloud** | ✓ **TimescaleDB** | - [**Timestream**](../Database-driver-Amazon-Timestream/) | Not available in Community Edition [**XLSX**](../Database-driver-XLSX/) | Not available in Community Edition **Yugabyte CQL** | Not available in Community Edition Back to top --- # Source: https://dbeaver.com/docs/dbeaver/FAQ/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * FAQ [ FAQ ](./) Table of contents * How to check driver version * How to update driver version * How to update driver version manually * How to get logs Table of contents * How to check driver version * How to update driver version * How to update driver version manually * How to get logs 1. [DBeaver](/docs/dbeaver) # FAQ ## How to check driver version¶ The easiest way to check your driver version. 1. In [Database Navigator](../Database-Navigator/), right-click your connection. 2. Click **Edit Connection**. 3. In the window that opens, click **Test Connection**. 4. In the pop-up, check the **Driver** field - that’s your driver version. ## How to update driver version¶ To update a driver version: 1. In [Database Navigator](../Database-Navigator/), right-click your connection. 2. Click **Edit Connection**. 3. In the window that opens, click **Driver Settings**. 4. Go to the **Libraries** tab. 5. Select the driver, then click **Download/Update**. * If you see a **Download/Update** button, it means the driver is available for download/update. 6. In the pop-up, click the arrow in the **Version** column. ![](../images/tutorial_images/download-update-driver.png) 7. Pick a version, then click **Download**. Note DBeaver uses two types of drivers: built-in and downloadable (Maven-based). You can only change the version for downloadable drivers. To update a built-in driver, update it manually. ## How to update driver version manually¶ To update a driver version manually: 1. In [Database Navigator](../Database-Navigator/), right-click your connection. 2. Click **Edit Connection**. 3. In the window that opens, click **Driver Settings**. 4. Go to the **Libraries** tab. 5. Double-click the driver file - this opens its folder. Info If there’s no driver listed (for example, you deleted it), click **Add File** or **Add Folder** , then select the driver file manually. 6. Replace the file with the new version. You need to download the JAR file manually. Sources vary depending on the driver: * **Official vendor site** \- some drivers are only available on the database vendor’s site. * **GitHub releases** \- many open-source drivers publish binaries in the **Releases** section. * **Maven Central** \- some drivers are available at [search.maven.org](https://search.maven.org). * **Other public repositories** \- some projects host drivers on project-specific sites or custom registries. Tip You don’t need to delete the whole folder - just replace or remove old JAR files to avoid conflicts. 7. Click **OK** , then **Test Connection** to verify it works. Info For details, see [Driver Manager guide](../Driver-Manager/) ## How to get logs¶ To check logs for errors or connection issues navigate to **Window - > Show View -> Error Log**. Info For more info, see [log files guide](../Log-files/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/File-Search/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * File search [ File search ](./) Table of contents * File search * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * File search 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Search # File search ## File search¶ To search file contents for a string, click the Search button on the main toolbar or the arrow next to the Search button and then **File Search** on the dropdown menu: ![](../images/ug/File%3DSearch-menu.png) The Search window opens displaying the File Search tab: ![](../images/ug/Search-window.png) You can apply a case sensitive search, search by regular expressions, search among particular file types (**File name patterns** field), and use the find and replace function. After you click **Search** , the results appear in a [Search](../Search-Tool/) view. The results represent a tree or list of files with the search combination highlighted: ![](../images/ug/File-search-results-view.png) The toolbar of the Search view for File search provides more tools in addition to those available for all search types: Button | Name | Description ---|---|--- ![](../images/ug/Show-next-previous-match-button.png) | **Show Next / Previous Match** | Open the file in a separate viewer and move the highlight to the next/previous match, respectively ![](../images/ug/Remove-selected-matches-button.png) | **Remove Selected Matches** | Removes selected row (row in focus) of the results ![](../images/ug/Remove-all-matches-button.png) | **Remove All Matches** | Removes all results in the view ![](../images/ug/Expand-Collapse-all-buttons.png) | **Expand/Collapse All** | Expand/collapse the tree of results The view also provides a view menu (click the **View Menu** button (![](../images/ug/View-menu-icon.png)) in the upper-right corner of the view) that contains the following items: Menu item | Description ---|--- **Show as List** | Presents the results in the form of list **Show as Tree** | Presents the results in the form of tree **Filters** | Opens Search Filters dialog box **Preferences** | Opens the Preferences window on the Search page Double-clicking a results row opens it in a separate viewer. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Filter-Database-Objects/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * Filter database objects [ Filter database objects ](./) Table of contents * Filter by object type * Filter by connection status * Filter using the context menu * Filter multiple objects at once * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Filter by object type * Filter by connection status * Filter using the context menu * Filter multiple objects at once 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Database Navigator # Filter database objects In the [Database Navigator](../Database-Navigator/) and [Database Object Editor](../Database-Object-Editor/), you can filter database objects to simplify the tree view. Filters apply to connections, schemas, tables, views, and other objects. Info A dots icon `(...)` next to a node name means that a filter is active on its subnodes. ![](../images/ug/Filtered-object.png) ## Filter by object type¶ Use the dropdown next to the filter mode button ![](../images/ug/filter-mode- button.png) to choose what types of objects to filter in the navigator tree: Icon | Filter option | Description ---|---|--- ![](../images/ug/filter-connections-button.png) | **Filter connections** | Filters connection nodes in the navigator tree. ![](../images/ug/filter-catalogs-and-schemas-button.png) | **Filter catalogs and schemas** | Filters catalogs and schemas. ![](../images/ug/filter-tables-procedures-button.png) | **Filter tables, procedures, etc.** | Filters leaf-level objects like tables, views, procedures, etc. ![](../images/ug/DB-filter-object-types.png) Start typing in the field to filter by name within the selected object type. Results update instantly. You can use: * Exact names — for example, `order` * Wildcards (`*`) — for example, `user*` * Multiple values separated by `|`, `,`, or space — for example, `user*, order report|log` ![](../images/ug/DB-multiple-filter.png) Tip When filtering catalogs/schemas or tables/procedures, only expanded parts of the tree are included. Collapse unused sections to improve performance. ## Filter by connection status¶ Use the toolbar in the **Database Navigator** to control which connections are shown: Icon | Filter option | Description ---|---|--- ![](../images/ug/show-all-connections-button.png) | **Show all connections** | Displays all saved connections. ![](../images/ug/show-connected-only-button.png) | **Show connected only** | Displays only currently active connections. You can switch between these modes by clicking the icon. ## Filter using the context menu¶ Right-click any object and use the **Filter** submenu: Filter option | Description ---|--- **Hide`[object name]`** | Hides this object, shows all others. **Show only`[object name]`** | Shows only this object, hides others. **Toggle filter** | Inverts the current filter (hides visible, shows hidden). **Clear filter** | Removes the filter entirely. **Configure`[objects]` filter** | Available on folders like **Tables** or **Indexes**. Opens advanced filtering options. See [Configure Filters](../Configure-Filters/). ## Filter multiple objects at once¶ 1. Select several objects of the same type (use `Ctrl` or `Shift`). 2. Right-click -> **Filter** -> Choose an option: Filter option | Description ---|--- **Hide N objects** | Hides selected objects. **Show only selected objects** | Shows only selected objects, hides the rest. To reset this filter, right-click the parent folder (with `(...)`), then click **Filter - > Clear filter**. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/GCP-Credentials/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * Google Cloud credentials [ Google Cloud credentials ](./) Table of contents * Default credentials * Key file * Web browser * OAuth (Pregenerated) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Default credentials * Key file * Web browser * OAuth (Pregenerated) 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. [Cloud connection settings](/docs/dbeaver/AWS-Permissions) 4. Google Cloud # Google Cloud credentials DBeaver supports Google Cloud IAM authentication. ![](../images/database/bigquery/bigquery-connection-main.png) Depending on how you authenticate in Google Cloud, choose one of the following credential types.: ## Default credentials¶ Use **Default credentials** to let Google Cloud find your credentials automatically. It looks through the following sources in order: 1. Environment variable `GOOGLE_APPLICATION_CREDENTIALS` 2. Active GCP CLI session 3. Shared user or service credentials file (for example, `application_default_credentials.json` in AppData) 4. Google Compute Engine metadata This is the easiest option if you already use GCP CLI or your system is configured with SSO or web identity credentials. Info For details, see the [GCP authentication guide](https://cloud.google.com/docs/authentication/provide-credentials-adc). ## Key file¶ Select **Key file** to manually provide a path to your credentials JSON file. This file contains private keys and authentication details for a user or service account. Info You can create or download a key file in the [Google Cloud Console](https://console.cloud.google.com/iam-admin/serviceaccounts). For details, see [Create and manage service account keys](https://cloud.google.com/iam/docs/keys-create-delete). ## Web browser¶ Select **Web browser** if your GCP account uses a web-based or SSO login. You’ll be redirected to the Google authorization page to sign in and grant access. Info This option uses the standard [OAuth 2.0 web server flow](https://developers.google.com/identity/protocols/oauth2/web-server) to authenticate and obtain access tokens. ## OAuth (Pregenerated)¶ Use **OAuth (Pregenerated)** when you already have an existing OAuth setup. Enter the following values: * **Client ID** – the OAuth client identifier * **Client Secret** – the client secret associated with your OAuth client * **Refresh Token** – a token that allows the product to refresh access automatically Info For more details, see [OAuth application integration](https://cloud.google.com/iam/docs/workforce-oauth-app). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/GCP-SSO/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * Google Cloud SSO [ Google Cloud SSO ](./) Table of contents * GCP CLI * GCP web browser-based authentication configuration * Connection configuration * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * GCP CLI * GCP web browser-based authentication configuration * Connection configuration 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. [Cloud connection settings](/docs/dbeaver/AWS-Permissions) 4. Google Cloud # Google Cloud SSO Note This feature is available in [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. GCP web browser-based authentication allows you not to use a service or user- based key file, or other default authorization methods. You can provide access to your connection by authorization through the Google account. ## GCP CLI¶ To enable SSO authorization, you need to install GCP CLI (Command Line Interface) utilities. [GCP CLI installation](https://cloud.google.com/sdk/docs/install) If DBeaver didn't find your executable CLI file (error message: "Authentication error: Error running GCP CLI. Is it installed on the local machine?)", you can add the path for your executable file manually in the Preferences -> Connections -> Cloud Configurations -> GCP Configuration ![](../images/ug/GCP_Preference_Page.png) ## GCP web browser-based authentication configuration¶ First `gcloud auth print-access-token` request to your CLI will be used. If token will be not empty, then this token will be used for the authentication. If token will be empty, then command `gcloud auth login` will be executed, which will open the web-browser and offer to choose your Google account. ## Connection configuration¶ In the DBeaver database connection dialog, you need to: * Set Authentication to `Google Cloud IAM`. * Set Credentials to `Web Browser`. * Add user and password info if they needed Now you can connect. DBeaver will open a web browser with SSO authorization. Choose your account with Goggle projects on the web page. As example: ![](../images/ug/GCP_connection_page_example.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Getting-started/ Expand all * [ Getting started ](..) Getting started * First steps [ First steps ](./) Table of contents * Introduction * First steps * DBeaver essentials * Additional resources * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Introduction * First steps * DBeaver essentials * Additional resources 1. [DBeaver](/docs/dbeaver) 2. Getting started # First steps Welcome to DBeaver, a powerful and user-friendly database management tool. This guide will help you get started with DBeaver, from installation to basic database operations. ## Introduction¶ DBeaver is an open-source universal database tool that supports a wide variety of databases including SQL, NoSQL, and more. It provides an intuitive interface for database management, development, and analysis. ## First steps¶ To ensure a smooth start with DBeaver, we have outlined the initial steps you need to take. These steps will guide you from download and installation to basic database operations, helping you to become familiar with DBeaver's environment and its powerful features. * **[Download DBeaver](https://dbeaver.com/download/)** Please download DBeaver from the official website. Choose the appropriate version for your operating system * **[Install DBeaver](../Installation/)** Follow the instructions to install DBeaver on your operating system. * **[Import license](../How-to-Import-License/)** If you have a PRO version, learn how to import your license to unlock the full capabilities of DBeaver. * **[Interface overview](../Application-Window-Overview/)** Get familiar with DBeaver's user interface to navigate through the tool efficiently. * **[Basic operations](../Basic-operations/)** Walk through the basic steps for your first use of DBeaver. ## DBeaver essentials¶ Refer to these resources for comprehensive support in your database operations. * **[Database Navigator](../Database-Navigator/)** Navigate through your database schemas and objects with ease. * **[Data Editor and Viewer](../Data-Editor/)** Manage and manipulate your data directly within DBeaver. * **[Database objects](../Database-Object-Editor/)** Create, modify, and manage your database objects. * **[Run queries](../SQL-Execution/)** Start executing your SQL queries and scripts. * **[Create tables](../New-Table-Creation/)** Define and create new tables within your database. * **[Database diagrams](../ER-Diagrams/)** Visualize and design your database structure. * **[Schema comparison](../Schema-compare/) and [Migration](../Data-migration/)** Compare and synchronize database schemas. * **[Export and Import](../Data-transfer/)** Move data and objects in and out of your database. * **[Backup and Restore databases](../Backup-Restore/)** Protect and recover your database data efficiently. ## Additional resources¶ Here are some resources for additional support and information: * **[DBeaver Blog](https://dbeaver.com/blog/)** Read about the latest developments, features, and insights from the DBeaver team on our official blog. * **[YouTube channel](https://www.youtube.com/channel/UC-yOjsQLSaJVEghg6UB3N7A)** Watch tutorials, feature overviews, and other helpful videos to get the most out of DBeaver. * **[Twitter updates](https://twitter.com/dbeaver_news)** Follow DBeaver on Twitter for the latest news, updates, and tips. * **[Edition comparison](https://dbeaver.com/edition/)** Compare different DBeaver editions to find the one that fits your needs the best. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Google-Bigtable/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * Bigtable [ Bigtable ](./) Table of contents * Bigtable connection * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Bigtable connection 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Google # Bigtable Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Supported features: \- Table data view \- Table data edit in document (json) mode \- Data filters \- SQL queries execution \- Data export and import ## Bigtable connection¶ ![](../images/database/bigtable/connection-page.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Google-Cloud-Explorer/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * Google cloud explorer [ Google cloud explorer ](./) Table of contents * Requirements for Google Cloud Platform connection * Connection setup * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Requirements for Google Cloud Platform connection * Connection setup 1. [DBeaver](/docs/dbeaver) 2. [Cloud services](/docs/dbeaver/Cloud-Explorer) 3. Cloud explorer # Google cloud explorer Note This feature is available in [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver offers enhanced capabilities for managing and connecting to Google Cloud Platform (GCP) databases directly from the DBeaver interface. The processes for creating and modifying connections are comprehensively detailed in the [Cloud Explorer article](../Cloud-Explorer/). This guide explains the essential steps and requirements to connect to a GCP databases using DBeaver. ## Requirements for Google Cloud Platform connection¶ Before initiating a connection to a Google Cloud Platform (GCP) database using DBeaver, ensure that you meet the following pre-requisites: * **Existing GCP account** : You must have an active and properly configured GCP account. If you do not have an account, you can create one by visiting the [GCP website](https://cloud.google.com/). * **Authentication set-up** : Proper authentication is crucial for a secure and successful connection to your GCP database. For detailed instructions on setting up authentication, refer to Google Cloud's [authentication documentation](https://cloud.google.com/docs/authentication). ## Connection setup¶ 1. Click on the Cloud Explorer button ![Cloud Explorer Button](../images/ug/cloud-explorer/cloud-explorer-button.png) or navigate to **Database** -> **Cloud Explorer** in the menu. 2. Proceed to the **Google Cloud Platform** section within Cloud Explorer. ![](../images/ug/cloud-explorer/gcp-cloud-configuration.png) 3. Select one of the available authentication methods in DBeaver. Tip For detailed information about the authentication methods supported by DBeaver for GCP connections, see the [Cloud Explorer documentation](../Cloud- Explorer/#google-cloud-platform). If your connection requires SSH, fill in the necessary credentials in the [**Tunnels**](../SSH-Configuration/) tab. 4. Verify the correctness of your credentials by clicking on the **Test Connection** button. Then click on **Apply and Close** to save your settings and close the settings window. 5. After completing the steps, the **GCP configuration** will appear in your configuration list. 6. Select the desired database from the drop-down menu to start connecting it to DBeaver. ![](../images/ug/cloud-explorer/gcp-cloud-services.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Grouping-Panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * Grouping Panel [ Grouping Panel ](./) Table of contents * How to use the Grouping panel * Viewing the query * Function management in the Grouping panel * Adding a function * Removing a function * Column management in the Grouping panel * Adding a column * Removing a column * Additional settings * Default sorting * Show duplicates only * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How to use the Grouping panel * Viewing the query * Function management in the Grouping panel * Adding a function * Removing a function * Column management in the Grouping panel * Adding a column * Removing a column * Additional settings * Default sorting * Show duplicates only 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # Grouping Panel The Grouping panel provides tools to calculate statistics based on a table of a custom SQL query. It uses `GROUP BY` queries to extract unique values for `COUNT` (default), `SUM`, `AVG`, `MIN`, `MAX`, and other analytics functions, displaying the results in dedicated columns. Info To open the **Grouping panel** click **Panels - > Grouping panel** on the [Right sidebar](../Data-Editor/#right-sidebar) or use [shortcut](../Shortcuts/#panels). ## How to use the Grouping panel¶ To obtain the grouping results for one or more columns of a data table, open the **Grouping panel** , then, in the results table, put the cursor onto the data type icon of the table header, and drag-n-drop the column(s) into the panel: ![](../images/ug/Grouping-drag-n-drop.png) If you add several columns to the panel, DBeaver groups data in the order the columns go and calculates statistics based on the grouping. ![](../images/ug/Grouping-Panel.png) ## Viewing the query¶ If you want to see the entire query, click on the **Query** button located in the top-left corner of the **Grouping panel** to open it. ![](../images/ug/Query-in-the-grouping-panel.png) ## Function management in the Grouping panel¶ ### Adding a function¶ By default, the `COUNT` function is used. You can add other functions as well. ![](../images/ug/Grouping-new-function.png) To add a function, follow these steps: 1. Click the **Edit grouping columns** button on the panel's toolbar. Alternatively, right-click the **Grouping panel** window and navigate to the **Edit grouping columns** option. 2. In the **Grouping Configuration** window, locate the **Functions** area. Click **Add** and type the function into the new row. * DBeaver provides auto-complete options for your convenience. * Indicate the column name in brackets. Note that `COUNT` is the only function that allows using `*` instead of specifying a column name. 3. To complete the process, click **OK**. ### Removing a function¶ To remove a function, in the same **Grouping Configuration** window, select the function and click **Remove** , then click **OK**. To remove all functions, click **Clear** and then **OK**. ## Column management in the Grouping panel¶ ### Adding a column¶ You can also manage columns in the same **Grouping Configuration** window. ![](../images/ug/Grouping-add-column.png) To add a column: 1. Click the **Edit grouping columns** button on the panel's toolbar. 2. In the **Grouping Configuration** window, go to the **Columns** area. Click **Add** and type the column name into the new row. * DBeaver provides auto-complete options for your convenience. 3. To complete the process, click **OK**. Tip You can add a column with an expression for MySQL/MariaDB databases. The expression will be calculated in the resulting column: ![](../images/ug/Grouping-column-expression.png) ### Removing a column¶ * To remove a column, in the same **Grouping Configuration** window, select the column and click **Remove** , then click **OK**. To remove all columns, click **Clear** and then **OK**. * Alternatively, you can remove a column by clicking the column name and then clicking the **Remove grouping column** button ![](../images/tutorial_images/Delete_button.png) in the panel's toolbar. To clear all results from the **Grouping panel** , click the **Clear grouping** button ![](../images/ug/Clear-columns-button.png). ## Additional settings¶ ### Default sorting¶ Click the **Default Sorting** button ![](../images/ug/Default-sorting- button.png) to access sorting options for the grouped data. The dropdown menu provides the following sorting criteria: Option | Description ---|--- **Unsorted** | Leaves the data in its original order. **Ascending** | Sorts the grouped data in ascending order. **Descending** | Sorts the grouped data in descending order. Select the desired option to apply the corresponding sorting criteria to the grouped data. ### Show duplicates only¶ Click the **Show duplicates only (COUNT > 1)** button ![](../images/ug/Show- duplicates-only-button.png) to filter the results and display only those rows where the `COUNT` is greater than 1. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/How-to-Import-License/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * Import license [ Import license ](./) Table of contents * Import from email * Import from the personal account * Import on startup * Activate license * Insert the license key into the License Manager * License Manager * Troubleshooting * Unable to activate a monthly subscription license * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Import from email * Import from the personal account * Import on startup * Activate license * Insert the license key into the License Manager * License Manager * Troubleshooting * Unable to activate a monthly subscription license 1. [DBeaver](/docs/dbeaver) 2. Licenses # Import license To start using commercial versions of DBeaver you can: * [buy](https://dbeaver.com/buy/) a subscription * request an [Academic license](https://dbeaver.com/academic-license/) if you are a student or a teacher * request a [Trial license](https://dbeaver.com/trial/) for 2 weeks * join [Early Access Program (EAP)](../Early-Access-Program-license/) You will receive a license text by email, and it will also be available in your personal account on our [website](https://dbeaver.com/). Info The license text contains your License ID (for example, `DB-841MRZHY-ZH54`), start date, and the license owner's name and company. ## Import from email¶ 1. Copy-paste the license key ![](../images/license/mail.png) Note You need to copy-paste the full license text (not just the license ID). The license text starts with “–” and ends with “==” characters. Sometimes an email client can corrupt the formatting of the license key that can cause an error. ![](../images/license/error.png) Therefore, you need to import your license key from your personal account on our site https://dbeaver.com/signin/. 2. Insert the copied license key to License Manager in DBeaver ## Import from the personal account¶ 1. [Sign in](https://dbeaver.com/signin/) 2. Open the **Licenses** tab, where you can find all your licenses ![](../images/license/tab.png) 3. Click the license ID link. Here you can find your license status, type, maintenance period, and end support date ![](../images/license/details.png) 4. At the bottom of the page you can find the license key required to start using DBeaver. There are two options how to copy your license key from the personal account: * press the **COPY TO CLIPBOARD** button, then press **OK**. The license text will be copied to the clipboard ![](../images/license/lic-copy.png) * press the **DOWNLOAD LICENSE** button, then press **OK**. The `.txt` file with your license key will be downloaded to your download folder. The file name is License ID, e. g. `DB-841MRZHY-ZH54`. ![](../images/license/lic-download.png) 5. Insert the copied license key to License Manager in DBeaver ## Import on startup¶ If you want DBeaver to detect the license file automatically (for example, when deploying on multiple machines), you can place the license file in a predefined location before the first launch. Info For details, see [License Administration](../License-Administration/). ## Activate license¶ ### Insert the license key into the License Manager¶ 1. Go to **Help - > DBeaver License Info -> License Manager** in DBeaver. ![](../images/license/help-info.png) The License information window can look different depending on whether you already have a valid license or not. ![](../images/license/information.png) 2. Open the License Manager and press the **Import** button to paste your license key. ![](../images/license/lic-import.png) * If you copied the license key to the clipboard, press the Paste button and then Import. * If you downloaded a `.txt` file with the license key, press the Load button and then select the file from Downloads. The license key will be pasted automatically. 3. Press the Import button and your license will be added to the License Manager. ![](../images/license/manager.png) 4. Now you can close the License Manager and start using DBeaver. ### License Manager¶ License Manager provides you with the following information about your licenses: * **License ID** – e.g. `DB-841MRZHY-ZH54` * **License type** – Trial, Academic, Subscription, or Standard * **Version** * **License owner’s name and company** * **Owner’s email** * **Issue time** – date of initial purchase * **End time** – date the license expires * **Number of users** – single user or multi-user license * **Support period** – duration of access to support system and updates * **State** – valid or expired ![](../images/license/manager.png) ## Troubleshooting¶ ### Unable to activate a monthly subscription license¶ A monthly subscription requires internet access on the workstation for the first activation and each prolongation. If you do not have an active internet connection or work behind a corporate firewall while importing the Subscription license, the following error can appear: Invalid subscription Can`t find the subscription information for license ‘DB-841MRZHY-ZH54’. Check your internet connection and/or firewall settings and restart the application. In this case, you need to check that DBeaver has internet access. If you're behind a firewall, you may need to configure a proxy. The UI option might not be available in such cases. For instructions, see [Configure proxy using system files](../Proxy-configuration/#configure-proxy-using-system-files). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/How-to-Reassign-License/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * Reassign license [ Reassign license ](./) Table of contents * Steps to reassign * Manage group licenses * Import users from CSV * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Steps to reassign * Manage group licenses * Import users from CSV 1. [DBeaver](/docs/dbeaver) 2. Licenses # Reassign license After purchasing a set of DBeaver licenses, you have to assign each license to an end user. If an employee leaves the company or the team that is using DBeaver, the license admin may need to reassign the license to another employee. You can reassign the license to another user in your personal account. ## Steps to reassign¶ 1. [Sign in](https://dbeaver.com/signin/). 2. Open the **Licenses** tab to view all your licenses. ![](../images/license/tab.png) 3. Click the **Assignment** subtab to manage license end-users and track license usage. ![](../images/license/tab-assign.png) 4. Select the license you need to reassign and press the icon in the right column. 5. In the pop-up window, enter the new license end user’s details: * Email * First and last name * Company Then press **SAVE**. The license owner will be changed, and the license key (which contains the license end user’s name and company) will be updated. ![](../images/license/reassign.png) Note When the license manager reassigns a license to another user, the license is completely recreated. The new user receives a new license, and the old license becomes invalid and is no longer visible in the customer’s account. ## Manage group licenses¶ If you have a group license, you can add users to it. To let another user manage the license, check **Allow User 1 to manage license users**. This user becomes a **license manager** and can add or remove users. Info You can assign multiple license managers for the same group license. Each of them will be able to manage the list of users independently. ![](../images/license/as-group.png) The license stays in your account, but the assigned user’s email appears in the **End user** column on the **Assignment** tab. The new user will also see the license in their account and can [import it](../How-to-Import-License/#import-from-email). They can’t change any license details. If the new user doesn’t have an account yet, it’s created automatically. They’ll get an email with a link to set a password, and the previous user will get an email that the license was removed. ### Import users from CSV¶ You can also upload a list of end users for a group license using a CSV file. Use this method when you need to assign many users at once. To do this: 1. Go to your **Assignment** tab 2. Click **Import from CSV** 3. Upload your `CSV` file containing the user details Each line in the CSV represents a user to be assigned to the group license. Example alice@dbeaver.com;Alice Cooper user-bob;Bob Bundy Back to top --- # Source: https://dbeaver.com/docs/dbeaver/How-to-Update-License/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * Update license [ Update license ](./) Table of contents * Update license information * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Update license information 1. [DBeaver](/docs/dbeaver) 2. Licenses # Update license Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. If your license has been renewed or upgraded, you can update it directly in DBeaver without re-importing the license file. ## Update license information¶ 1. Go to **Help - > DBeaver License Info -> License Manager**. 2. Click **Refresh from server** to update your license details. The license information will be refreshed automatically if a new license or extension is available on the server. Tip You can find your license text in the email you received after purchase or in your [personal account](../How-to-Import-License/#import-from-email). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/How-to-add-additional-artifacts-to-the-driver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * How to add additional artifacts to the driver [ How to add additional artifacts to the driver ](./) Table of contents * Modes * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Modes 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Driver settings # How to add additional artifacts to the driver DBeaver has the functionality to add and edit artifacts in existing drivers. You can add or edit artifacts in existing drivers: 1. **Open the driver** : Go to **Database** -> **Driver Manager** -> select a driver -> **Libraries** tab 2. **Edit an artifact** : Double-click the library you want to change 3. **Add an artifact** : Click **Add Artifact** ## Modes¶ When adding artifacts, you can choose between two modes. Editing only supports the second one. 1. **Dependency declaration** : Paste artifact coordinates or Maven XML. Supported formats: * **Gradle format** : group:artifact_name:version * **Single Maven dependency** : group artifact version * **Multiple Maven dependencies** : group artifact version group artifact version ![Dependency Declaration](../images/edit-maven-artifacts-dependency- declaration.png) 2. **Declare artifacts manually** : Add artifacts one at a time with input fields. ![Declare artifacts manually](../images/edit-maven-artifacts-manual.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/How-to-import-Connections-from-External-Tools/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * Import connections from external tools [ Import connections from external tools ](./) Table of contents * How to import connections * Custom connections format * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How to import connections * Custom connections format 1. [DBeaver](/docs/dbeaver) 2. Tutorials # Import connections from external tools DBeaver provides the capability to import your connection settings from several commercial tools, making it easy to switch whether you are working simultaneously with multiple tools or planning a full move to DBeaver. This feature allows you to migrate all necessary database connections, saving time and eliminating the need to manually recreate each connection. Note Secure data, such as SSH keys and passwords, are not imported automatically for security reasons. You will need to enter this information manually in DBeaver after the import process. You can import connection settings from the following tools: * DBVisualizer * JetBrains IDE * Navicat * Oracle SQL Developer * SQL Squirrel * Toad Note Import functionality from DBVisualizer is supported only for versions up to version 7. Versions newer are not currently supported for import. ## How to import connections¶ To import your database connections from the tools above into DBeaver, follow these steps: 1. Go to **File - > Import**. 2. Select the **Third Party Configuration** tab. 3. Choose the tool from which you want to import your connections. 4. Follow the specific steps provided for each tool to complete the import process. ![](../images/import-connections-wizard.png) ### Custom connections format¶ If you need to import connections from `CSV`/`XML` format, follow these steps: 1. In the list of tools, select **Custom**. 2. A window will open where you can select the required database driver. 3. In the following window, choose the input type (`XML`/`CSV`), specify the path to the file, and select the encoding from the dropdown menu. 4. Click the **Finish** button to complete the import process. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/How-to-set-a-variable-if-dbeaver-ini-is-read-only/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * How to set a variable if dbeaver.ini is read only [ How to set a variable if dbeaver.ini is read only ](./) Table of contents * config path * For Linux * For Windows * config example * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * config path * For Linux * For Windows * config example 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # How to set a variable if dbeaver.ini is read only If you need to set some variable and `dbeaver.ini` have read-only permissions (this can happen, for example, in Flatpak or Snap), you can use the `config.ini`. ## config path¶ ### For Linux¶ You can find correct path to your configuration directory with **config.ini** when open DBeaver `Help -> Installation Information -> Configuration` then _**type filter text**_ `org.osgi.framework.storage` ![image](https://user- images.githubusercontent.com/46003534/168237839-9c8a79ba-e49e-4639-9fe7-d898b3c3c324.png) * * * If **config.ini** does not exist, you can create it in the configuration directory `nano config.ini` * * * ### For Windows¶ You can find correct path to your configuration directory with **config.ini** when open DBeaver `Help -> Installation Information -> Configuration` then _**type filter text**_ `org.osgi.framework.storage` Example output: org.osgi.framework.storage=file:/C:/Users/user/.eclipse/org.jkiss.dbeaver.product_22.0.5_1535670467_win32_win32_x86_64 * * * If **config.ini** does not exist, you can create it in the configuration directory. * * * ## config example¶ For example, you can set system property with your custom path to point to the keystore you created. `javax.net.ssl.trustStore=/path/to/your/cert` Or, for example, you can change the language. `osgi.nl=fr` Back to top --- # Source: https://dbeaver.com/docs/dbeaver/How-to-work-with-database-Partitions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * Database partitions [ Database partitions ](./) Table of contents * Creating Partitions * Creating Partitions using SQL Editor * Saving changes * Creating Partitions in Oracle * Step 1: Create a new table and columns * Step 2: Modify a partitioning type * Step 3: Create a new partition * Creating a subpartition * Step 4: Save the table * Working with partitioned tables * Deleting Partitions * Database Navigator * Properties Editor * SQL Editor * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Creating Partitions * Creating Partitions using SQL Editor * Saving changes * Creating Partitions in Oracle * Step 1: Create a new table and columns * Step 2: Modify a partitioning type * Step 3: Create a new partition * Creating a subpartition * Step 4: Save the table * Working with partitioned tables * Deleting Partitions * Database Navigator * Properties Editor * SQL Editor 1. [DBeaver](/docs/dbeaver) 2. Tutorials # Database partitions Partitioning is a database design technique when data is split across multiple tables or databases but is logically still one table. This technique is proper when dealing with large tables, as it can improve query performance, manageability, and availability. Note Not all databases support partitioning, and the level of support and specific functionalities may vary among those that do. Always refer to your specific DBMS documentation to understand the partitioning capabilities it offers. ## Creating Partitions¶ 1. The first step to creating Partitions is to [create a table](../New-Table-Creation/). Consider a table with the following columns: orderid int4, customerid int4, orderdate date, year int4 2. Next, go to the **Properties** tab, and find the **Partition by** field. Here, you need to specify the Partition criteria. For instance, to Partition the data based on the `year` column, you can use `RANGE (year)`. 3. Navigate to the **Partitions** in tabbed Editors. Right-click and select **Create New Partition**. This action will open a new **Partition** table window. 4. In the new window, specify the **Partition Expression**. This expression defines the boundaries for the Partition. For example, to create a Partition for the years `2023` and `2024`, you can use `FOR VALUES FROM (2023) TO (2024)`. ## Creating Partitions using SQL Editor¶ You can also create a Partition by using SQL statements. The specific SQL command may vary slightly depending on the type of your database. 1. Here's an example of how to create a partitioned table `orders` based on a range of Partition on the `year` column using PostgreSQL syntax: CREATE TABLE orders ( orderid int NOT NULL, customerid int NOT NULL, orderdate date NOT NULL, "year" int NOT NULL ) PARTITION BY RANGE ("year"); Note The example provided above uses PostgreSQL syntax for partitioning. For other databases, such as Oracle, MySQL, or SQL Server, it is necessary to use the syntax that corresponds to the specific database system. 2. Next, you would create Partitions within this table. For instance, if you want to create a Partition for the year `2023`: CREATE TABLE orders_2023 PARTITION OF orders FOR VALUES FROM (2023) TO (2024); ### Saving changes¶ Once you have configured the Partition properties, saving these changes to the database is essential. Until you commit your modifications, the new Partition will only exist within DBeaver and will not be added to the actual database table. Here are three options for committing the changes: * Click on **File** -> **Save** -> **Persist**. * Select the desired table in the **Database Navigator** and press `Ctrl+S` (or `CMD+S` for macOS), choose **Persist** to save the changes. * Utilize the **Save** button ![](../images/tutorial_images/10b_SaveButton.png) located at the bottom of the **Properties editor** and press **Persist** to save the changes. ## Creating Partitions in Oracle¶ Partitions in Oracle are useful for managing large tables by dividing them into smaller, more manageable pieces. For a detailed guide on creating partitions and understanding the benefits of each partitioning type, refer to the [Oracle Database Partitioning Documentation](https://docs.oracle.com/en/database/oracle/oracle- database/19/vldbg/partition-concepts.html#GUID-EA7EF5CB- DD49-43AF-889A-F83AAC0D7D51). To create partitions in Oracle via DBeaver, follow these steps: Tip Besides using the GUI for creating partitions, you can also create partitions through the SQL Editor. For instructions on using the SQL Editor for partitioning, refer to the Creating Partitions using SQL Editor section. ### Step 1: Create a new table and columns¶ 1. Create a new table including the columns that you need. 2. Specify the column(s) that will be used for partitioning in the **Partition keys** field. 3. If necessary, specify any subpartition keys by entering the relevant column name(s) in the **Subpartition Keys** field. Tip You can list multiple columns separated by commas. The case of the column names does not matter, you can use `column1` or `CoLumN1`. ![](../images/database/oracle/partitions/new-table-and-columns-in-oracle.png) ### Step 2: Modify a partitioning type¶ Optionally, navigate to the **Statistics** tab for partitioning customization. ![](../images/database/oracle/partitions/modify-partition-type-in- statistics.png) Setting | Description | Default Value ---|---|--- **Partition Type** | Determines the method used for partitioning the table. | `RANGE` **Subpartition Type** | Defines the method for subpartitioning, if subpartitions are used. | `RANGE` Note You can only change the **Partition Type** and **Subpartition Type** for a new table, not an existing one. To customize the partition and subpartition types: 1. Click on the **Partition Type** or **Subpartition Type** value field. 2. A dropdown menu will appear where you can select from options such as `RANGE`, `HASH`, `LIST`, or `SYSTEM`. Partitioning Type | Description ---|--- **RANGE** | Organizes data into partitions based on a range of values. **HASH** | Distributes data across partitions based on a hash key. **LIST** | Groups data into partitions based on a list of explicit values. **SYSTEM** | Allows manual control over which partition stores each row. Each type serves a different purpose and can be selected based on the specific requirements of your data organization strategy. ### Step 3: Create a new partition¶ 1. Go to the **Partitions** tab. 2. Create a new partition with the desired values. ![](../images/database/oracle/partitions/new-partition-creation.png) #### Creating a subpartition¶ Once you have defined the partition keys and, if needed, subpartition keys, you can create a subpartition by following these steps: 1. Navigate to the **Partitions** tab. 2. Right-click on the partition within which you want to create a subpartition. 3. From the context menu, select **Create** and then **Subpartition** from the subsequent options. Important Ensure that the subpartitioning keys and types are already defined as these will dictate how the subpartitions are organized. ### Step 4: Save the table¶ After setting up the partitions, save the table to finalize the creation process. ![](../images/database/oracle/partitions/persist-changes-partition.png) ## Working with partitioned tables¶ After you've created a partitioned table in DBeaver, you can interact with it just like any other table. Remember, though, that the Partition expression will impact which data goes into which Partition. Consider the table you created before, partitioned by `RANGE (year)` with a Partition for the years `2023` to `2024`. 1. To insert data into the table, you would use a regular `INSERT` statement: INSERT INTO orders (orderid, customerid, orderdate, "year") VALUES (1, 101, '2023-01-01', 2023), (2, 102, '2023-06-01', 2023), (3, 103, '2024-01-01', 2024); Each row of data would be automatically directed to the appropriate Partition based on the year value. For instance, the first two rows would be stored in the Partition for `2023`, and the third would be stored in the Partition for `2024`. 2. To retrieve data from your partitioned table, you use a standard `SELECT` statement: SELECT * FROM orders WHERE year = 2023; This will return all rows from the `2023` Partition. ## Deleting Partitions¶ Deleting a Partition in DBeaver is simple and can be done via the [**Database Navigator**](../Database-Navigator/), the [**Properties Editor**](../Properties-Editor/), or the [**SQL Editor**](../SQL-Editor/). Warning When a Partition is deleted, all the data stored in that Partition is permanently lost. The Partition is also removed from the table's Partitioning scheme. It is always recommended to back up the data before deleting a Partition. ### Database Navigator¶ 1. In the **Database Navigator** , expand the table which contains the Partition you want to delete. 2. Right-click on the Partition, then click **Delete**. ### Properties Editor¶ 1. Go to the **Partitions** tab of the Properties Editor for your table. 2. Right-click on the Partition, then click **Delete**. ### SQL Editor¶ You can also delete a Partition by using SQL statements. The specific SQL command may vary slightly depending on the type of your database. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Implementing-Constraints/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * Implementing constraints [ Implementing constraints ](./) Table of contents * Primary key * Create * Saving changes * Modify * Delete * Unique key * Check expression * Restrictions * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Primary key * Create * Saving changes * Modify * Delete * Unique key * Check expression * Restrictions 1. [DBeaver](/docs/dbeaver) 2. [Tutorials](/docs/dbeaver/New-Table-Creation) 3. Table Creation # Implementing constraints As you continue to explore the intricacies of [table](../New-Table-Creation/) structures, understanding the role and functionality of constraints becomes essential. Constraints are rules that we apply to data [columns](../Creating- columns/) in a table when we want to limit the type of data that can go into a table. This can help ensure the accuracy and reliability of our data. While creating constraints is not always necessary, it can be a powerful tool in the table creation process. Just like you create columns, you can also define constraints that uphold the integrity of your data. Constraints can be as simple as ensuring uniqueness in a column or as complex as a check expression that defines acceptable values for a column. In this guide, you'll learn how to create, modify, and delete constraints, as well as how to customize their settings to suit your needs. You'll discover how to create primary keys, unique keys, and check expressions. You'll also learn about the restrictions and considerations you need to keep in mind when working with constraints. ## Primary key¶ Primary keys are a crucial part of your database structure, uniquely identifying each record in a table. When you define a primary key, the database ensures no duplicate values exist in the specified column(s), maintaining data integrity and improving performance. DBeaver simplifies this process, providing an intuitive interface for creating, modifying, and deleting primary keys. ### Create¶ Creating a new primary key in DBeaver involves a series of steps that guide you through the process. Here's how you can do it: 1. You can start the process of creating a new constraint in three ways: * Using the **[Properties editor](../Properties-Editor/)** : Open the Properties Editor and navigate to the **Constraints** tab of the corresponding table. This is where you'll find all the existing constraints for the table and where you'll create new ones. ![](../images/tutorial_images/8_New_Constraint.png) * Using the **[Database Navigator](../Database-Navigator/)** : Navigate to the database where the table you want to add a constraint to is located. Find and select the table for which you want to create a new constraint. Within the selected table, you'll find a folder named **Constraints**. * You can also utilize the **Create New Constraint** button ![](../images/tutorial_images/Constraint_create_button.png) located at the bottom of the **Properties editor**. Tip You can create primary key during the column creation process as described in the article [Creating columns](../Creating-columns/#create). 2. Depending on the method you chose in step 1, either right-click on the window (in the **Properties Editor**) or within the **Constraints** folder (in the **Database Navigator**), and select **Create New Constraint**. If you're using the third method, simply click the **Create New Constraint** button. This will open a new window where you'll be able to define the details of your new constraint. ![](../images/tutorial_images/8a_Create_New_PK.png) Field | Description ---|--- **Name** | Here, you can specify the name of the constraint. It's a good practice to choose a name that clearly indicates the purpose of the constraint. **Type** | This is where you select the type of constraint. Options include Primary Key, Unique Key, Check. The type of constraint you choose will depend on the rule you want to enforce on the column. **Columns** | In this section, you can select the column or columns that the constraint will apply to. If you're creating a composite constraint, you can select multiple columns. 3. After selecting the column, click **OK** to save your new constraint. A window will appear displaying the newly created primary key. This is a good time to double-check that everything is correct. #### Saving changes¶ Once you have configured the constraint properties, it is essential to save these changes to the database. Until you commit your modifications, the new constraint will only exist within DBeaver and will not be added to the actual database table. Here are three options for committing the changes: * Click on **File** -> **Save** -> **Persist**. * Select the desired table in the **Database Navigator** and press `Ctrl+S` (or `CMD+S` for Mac OS), choose **Persist** to save the changes. * Utilize the **Save** button ![](../images/tutorial_images/10b_SaveButton.png) located at the bottom of the **Properties editor** and press **Persist** to save the changes. ### Modify¶ To modify an existing primary key, you need to first delete it and then add a new primary key with the updated parameters. Note Remember, modifying primary keys should be done with care. Primary keys are integral to maintaining the integrity of your data, and changing them can have significant effects on your database. Always double-check your changes and make sure they align with your data requirements. ### Delete¶ 1. You can delete a primary key either through the **Properties Editor** or the **Database Navigator** : * Using the **Properties Editor** : Open the Properties Editor, navigate to the **Constraints** tab of the corresponding table, and find the constraint you want to delete. ![](../images/tutorial_images/8b_Delete_PK.png) * Using the **Database Navigator** : Navigate to the database where the table with the constraint is located. Find and select the constraint, open the **Constraints** folder, and find the constraint you want to delete. 2. To delete a primary key, right-click on the key's name and select **Delete** , or you can select the necessary primary key and press the `Delete` key, or **Delete button** ![](../images/tutorial_images/Delete_button.png) (in the **Bottom Menu** of the **Properties Editor**). 3. A confirmation dialog will appear, asking you to confirm the deletion. Before proceeding, ensure that you've selected the correct constraint for deletion. 4. After confirming the deletion, you'll need to persist the changes to apply them to the database. Important Be particularly cautious if you're considering using the **Cascade delete** option. This option will not only delete the primary key but also any dependent records in your database. This can lead to significant data loss if not handled carefully. ## Unique key¶ A unique key is a tool that ensures distinct values within a column or a group of columns in a table. While it can identify unique records, it doesn't have to be the primary key. You can create a unique key on a single column or multiple columns, ensuring that each value is unique. This is crucial for maintaining data integrity within your table. If you attempt to insert a duplicate value into a column with a unique key constraint, you'll encounter an error. The processes of creating, deleting and modifying a unique key are similar to those for a primary key. ![](../images/tutorial_images/8c_Create_Unique_Key.png) ## Check expression¶ A check expression in a database is also a constraint, it defines acceptable values for a column. It enforces specific conditions, ensuring that the data in the column complies with the defined rules. The processes of creating, deleting and modifying a check expression are similar to those for a primary key. For instance, suppose you have a column named "name" and you want to ensure that its value is never an empty string. You could create a check expression as follows: name <> '' This would prevent any records from being inserted or updated with an empty string for the "name" column. ![](../images/tutorial_images/8d_Check_Expression.png) Note Check expressions are a powerful tool for maintaining data integrity. They enforce specific conditions on your data, preventing invalid entries. Always consider the implications of your actions when working with check expressions. ### Restrictions¶ Working with constraints comes with certain restrictions that you need to be aware of. These restrictions are in place to maintain the integrity of your data and prevent unwanted changes. Here's what you need to know: * **Unique Values** : When creating a primary key or unique constraint, the column(s) you choose must contain unique values. If there are duplicate values in the column(s), the constraint creation will fail. * **Null Values** : Primary keys cannot contain null values. If the column(s) you choose for a primary key contains null values, you will need to either remove or replace these before creating the constraint. Unique constraints, on the other hand, typically allow for multiple null values. * **Data Type Compatibility** : The type of constraint you want to create may have specific data type requirements. For example, check constraints require a Boolean expression, so the column(s) involved must be able to participate in such an expression. * **Existing Data Compliance** : When creating a check constraint, all existing data in the table must comply with the check condition. If any rows violate the condition, the constraint creation will fail. * **Performance Impact** : Creating constraints, especially on large tables, can have a performance impact. This is because the database needs to check the constraint condition for all existing rows. This might take considerable time and resources for large tables. * **Modifying Constraints** : Constraints cannot be directly modified. This is because constraints are defined with specific parameters that can't be changed directly. * **Deleting Constraints with Dependencies** : You can't delete a primary key in a table with records unless you first remove all dependent foreign keys. This is because the primary key is likely being referenced by these foreign keys, and deleting it would break these references and potentially cause data integrity issues. **Further Reading:** [New Table Creation](../New-Table-Creation/) | [Creating columns](../Creating-columns/) | Implementing Constraints | [Utilizing foreign keys](../Utilizing-Foreign-Keys/) | [Creating indexes](../Creating-Indexes/) | [Incorporating triggers](../Incorporating-Triggers/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Import-SSL-Certificates/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * Import custom certificates [ Import custom certificates ](./) Table of contents * Add certificates * Learn more * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Add certificates * Learn more 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. [Connection network options](/docs/dbeaver/SSH-Configuration) 5. [SSL](/docs/dbeaver/SSL-Configuration) 6. Truststore management # Import custom certificates DBeaver can import certificates from a predefined folder at startup. This method is useful for databases protected by self-signed certificates. It ensures secure connections without manual setup, especially when a firewall or internal security policies require specific certificates. Tip If you prefer managing certificates manually through the interface, see [Managing certificates in the Custom Truststore](../Managing-Truststore- Settings/). ## Add certificates¶ To add a certificate, place the file in the `{DBeaverData}/secure/custom` or in `{DBeaverData}/secure/custom-certs` folder. DBeaver will detect and import it on startup. For more details on `DBeaverData` location, see [Workspace location](../Workspace-Location/). Important * Only certificates are imported, not private keys. * The `custom-certs` directory must not contain any extra files or subfolders. ## Learn more¶ For general SSL configuration, see [SSL overview](../SSL-Configuration/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Importing-CA-certificates-from-your-local-Java-into-DBeaver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * Importing CA certificates from your local Java into DBeaver [ Importing CA certificates from your local Java into DBeaver ](./) Table of contents * Step 1 - locate your Java * Windows * macOS * Linux * Step 2 - Find the JRE in DBeaver installation * Step 3 - Copy the cacerts * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Step 1 - locate your Java * Windows * macOS * Linux * Step 2 - Find the JRE in DBeaver installation * Step 3 - Copy the cacerts 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Importing CA certificates from your local Java into DBeaver Note This article is relevant for you if you work behind the corporate firewall with a different root certificates set. In other cases, your issues can be caused by the incorrect [SSL Configuration](../SSL-Configuration/). It's possible that your system administrator has installed a local Java and imported the required certificates to its keystore. We can use them to fix the issue. ## Step 1 - locate your Java¶ ### Windows¶ Press Windows + R to open the Run window. Type `cmd` in the prompt and press OK. It will open the command prompt. In the command prompt, type the following and press Enter: where java ### macOS¶ Open the Terminal and execute the following command: /usr/libexec/java_home -V ### Linux¶ Open a terminal and execute the following command: readlink -e /usr/bin/java ## Step 2 - Find the JRE in DBeaver installation¶ It's pretty easy. Just find the path where you installed DBeaver and open the `jre` folder there. ## Step 3 - Copy the cacerts¶ Open the folder with the Java you found in step 1. Locate the `cacerts` files under `/lib/security`, then copy-paste it into `/lib/security`, replacing the old file. Restart DBeaver and you are ready to go. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Incorporating-Triggers/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * Incorporating triggers [ Incorporating triggers ](./) Table of contents * Create * Function * Trigger * Saving changes * Modify * Delete * Restrictions * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create * Function * Trigger * Saving changes * Modify * Delete * Restrictions 1. [DBeaver](/docs/dbeaver) 2. [Tutorials](/docs/dbeaver/New-Table-Creation) 3. Table Creation # Incorporating triggers This article focuses on triggers, essential components in database management. Triggers are procedures that are automatically executed in response to certain events in a database. They are integral to the creation and manipulation of [tables](../New-Table-Creation/), enforcing [constraints](../Implementing- Constraints/), and automating [tasks](../Task-Management/). The process involves creating a function, which is then used in a trigger. For example, a function can check if a new salary value is negative and raise an exception. This function can be used in a trigger that runs before any `INSERT` or `UPDATE` operations on a salary table. However, triggers come with restrictions and can impact performance, so their use should be optimized. The behavior of triggers can vary based on the database system in use, so always refer to the specific documentation for your system. ## Create¶ ### Function¶ 1. To create a trigger, start by creating a function. Here are three ways you can do it: 2. Open the **[Properties editor](../Properties-Editor/)** of the database and navigate to the **Functions** tab of the corresponding database. 3. Navigate to the database where you want to add a function in the **[Database Navigator](../Database-Navigator/)**. Within the selected database, you'll find a folder named **Functions**. ![](../images/tutorial_images/15_Create_New_Function.png) \- Additionally, to create a new function, you can utilize the **Create New Function** button ![](../images/tutorial_images/Create_New_Function_Button.png) located at the bottom of the **Properties editor**. 1. Depending on the method you chose in step 1, either right-click on the window (in the **Properties Editor**) or within the **Functions** folder (in the **Database Navigator**), and select **Create New Function**. If you're using the third method, simply click the **Create New Function** button. This will open a new window where you'll be able to customize the function's settings to suit your needs. ![](../images/tutorial_images/15a_Functions_Parameters.png) Field | Description ---|--- **Function Name** | This is the name you choose for the function. It should be unique within the schema where the function is being created. **Type** | In this case, you would select **Function**. **Language** | This is the programming language in which the function is written. For most database systems, this would be SQL or a variant of SQL, such as PL/pgSQL for PostgreSQL or PL/SQL for Oracle. **Return Type** | This specifies the type of value the function will return. For a trigger function, this is usually specified as **trigger**. **Note** : These settings can vary depending on the specific database system you're using. Always refer to the documentation for your database system for the most accurate information. 1. After you've chosen the needed settings for your function, you'll need to write the actual code for the function. This is done in the **Source** section. ![](../images/tutorial_images/15b_Function_Source.png) This function will be called when the trigger is activated. The function you write will depend on what you want the trigger to do. For example, if you want the trigger to check if a new salary value is negative and raise an exception if it is, you might write a function like this: CREATE OR REPLACE FUNCTION company.salary_trigger() RETURNS trigger AS $function$ BEGIN IF NEW.salary_amount < 0 THEN RAISE EXCEPTION 'Error: Salary cannot be negative'; END IF; RETURN NEW; END; $function$ language plpqsql ### Trigger¶ 1. Creating a trigger is a process that mirrors the creation of a function. Once your function is defined, you can move on to create the trigger. This can be done through the **Properties Editor** or the **Database Navigator**. 2. In the **Properties Editor** , you can navigate to the **Triggers** section associated with the table for which you want to create the trigger, right-click on the window and select **Create New Trigger**. Here, you can also select **Create New Trigger** button ![](../images/tutorial_images/Create_New_Trigger_Button.png) from the **Bottom menu**. ![](../images/tutorial_images/16_Create_New_Trigger.png) * Similarly, in the **Database Navigator** , you can right-click on the relevant table, select **Triggers** , and then choose **Create New Trigger**. * Next, you need to provide a name for the trigger and specify the function that it should call when it's activated. The trigger's function is typically written to perform a specific task when certain conditions are met. For example, if you've written a function to check if a new salary value is negative, you can create a trigger that calls this function before any `INSERT` operations on the salary table. * Finally, describe the code for the trigger. ![](../images/tutorial_images/16b_Trigger_Source.png) For instance: CREATE TRIGGER check_negative_salary_trigger BEFORE INSERT ON company.salary FOR EACH ROW EXECUTE function company.salary_trigger(); In this example, a `salary_trigger()` function is created that evaluates the new salary value (NEW.salary). If the salary is negative, it throws an exception with an error message. Then, a `check_negative_salary_trigger` is established to run this function before any `INSERT` operations on the "salary" table. Should the salary value be negative, an exception is triggered and the operation is stopped. ### Saving changes¶ Once you have configured the trigger and function properties, it is essential to save these changes to the database. Until you commit your modifications, the new trigger and function will only exist within DBeaver and will not be added to the actual database. Here are three options for committing the changes: * Click on **File** -> **Save** -> **Persist**. * Select the desired table in the **Database Navigator** and press `Ctrl+S` (or `CMD+S` for Mac OS), choose **Persist** to save the changes. * Utilize the **Save** button ![](../images/tutorial_images/10b_SaveButton.png) located at the bottom of the **Properties editor** and press **Persist** to save the changes. ## Modify¶ In the realm of database management, the need to modify existing functions or triggers is a common occurrence. Whether it's to correct an error, optimize performance, or adapt to new requirements, the ability to modify these elements is crucial. DBeaver offers intuitive and efficient ways to make these modifications. The DBeaver interface provides multiple pathways to access and modify functions or trigger: * **Properties Editor** : Open the **Properties Editor** by double-clicking on the database name (for functions) and table name (for triggers). Within the selected database or table, you'll find a folder named **Triggers** or **Functions**. Right-click on the trigger or function you want to modify and select **View Trigger** or **View Function**. * **Bottom Menu** : In the **Properties Editor** interface, use the **View Indexes** or **View Function** button ![](../images/tutorial_images/View_column_button.png). * **Database Navigator** : In the **Database Navigator** , select the appropriate database or table. Within the selected database or table, you'll find a folder named **Triggers** or **Functions**. Right-click the trigger or function and select **View Index** or **View Function**. ![](../images/tutorial_images/17_View_Function_Trigger.png) ## Delete¶ You can delete an index either through the **Properties Editor** or the **Database Navigator** : * Using the **Properties Editor** : Open the Properties Editor, navigate to the **Triggers** or **Functions** tab of the corresponding database (for functions) and table (for triggers), and find the trigger you want to delete. * Using the **Database Navigator** : Navigate to the database where the table with the trigger or function is located. Open the **Triggers** or **Functions** folder, and find the trigger or function you want to delete. ![](../images/tutorial_images/18_Delete_Function_Trigger.png) 1. To delete the trigger or function, right-click on the trigger's or function's name and select **Delete** , or you can select the necessary trigger or function and press the `Delete` key, or **Delete button** ![](../images/tutorial_images/Delete_button.png) (in the **Bottom Menu** of the **Properties Editor**). 2. A confirmation dialog will appear, asking you to confirm the deletion. Before proceeding, ensure that you've selected the correct trigger or function for deletion. 3. After confirming the deletion, you'll need to persist the changes to apply them to the database. ## Restrictions¶ * **Recursive Triggers** : Some databases allow recursive triggers, where a trigger can call itself. This can lead to infinite loops and excessive system load if not handled correctly. * **Data Modification** : Triggers can't be used to modify a table that is already being used (for reading or modifying) in the statement that invoked the function or trigger. * **Execution Order** : The order in which multiple triggers are fired isn't guaranteed. This can lead to unexpected results if triggers have interdependencies. * **Performance** : Triggers can slow down data modification operations because they add extra processing. They should be used sparingly and optimized for performance. * **Transaction Control Statements** : In many SQL databases, transaction control statements (like COMMIT and ROLLBACK) are not allowed within trigger code. However, exceptions apply depending on the database system. **Further Reading:** [New Table Creation](../New-Table-Creation/) | [Creating columns](../Creating-columns/) | [Implementing Constraints](../Implementing-Constraints/) | [Utilizing foreign keys](../Utilizing-Foreign-Keys/) | [Creating indexes](../Creating-Indexes/) | Incorporating triggers Back to top --- # Source: https://dbeaver.com/docs/dbeaver/InfluxDB/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * InfluxDB [ InfluxDB ](./) Table of contents * Connecting to Influx Server * Browsing InfluxDB schema * Executing InfluxQL * Executing Flux * Query example * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Connecting to Influx Server * Browsing InfluxDB schema * Executing InfluxQL * Executing Flux * Query example 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # InfluxDB Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver supports InfluxDB schema browser, data viewer and InfluxQL queries execution. DBeaver uses InfluxDB Java driver 2.12 to operate with the server over HTTP/HTTPS (standard InfluxDB protocol). It supports InfluxDB servers of any version (in the moment of writing). ## Connecting to Influx Server¶ You can connect directly to a server or use SSH tunneling or SOCKS proxy. ![](../images/database/influxdb/influxdb-connection-init.png) ![](../images/database/influxdb/influxdb-connection-ssh.png) ## Browsing InfluxDB schema¶ InfluxDB is [TimeSeries database](https://docs.influxdata.com/influxdb/v1.6/concepts/crosswalk/), it does not support tables, foreign keys and other relational entities. DBeaver does not support data insert/update in InfluxDB. Database is basically a in read-only state for DBeaver. You can browse schema and view/analyse data. While data itself is loaded by various sensors/data collectors in real time. Instead of tables InfluxDB has [measurements](https://docs.influxdata.com/influxdb/v1.6/concepts/key_concepts/#measurement). Instead of columns it has [fields](https://docs.influxdata.com/influxdb/v1.6/concepts/key_concepts/#field- key) and [tags](https://docs.influxdata.com/influxdb/v1.6/concepts/key_concepts/#tag- key). ![](../images/database/influxdb/inflixdb-schema.png) ## Executing InfluxQL¶ **versions lower than 2** [InfluxQL](https://docs.influxdata.com/influxdb/v1.6/query_language/) is a query language similar to SQL. DBeaver fully supports all InfluxQL statements. Query results are presented as grid or as graphs: ![](../images/database/influxdb/inflixdb-ql.png) ![](../images/database/influxdb/inflixdb-ql2.png) ## Executing Flux¶ **versions higher than 2** [Flux](https://docs.influxdata.com/flux/v0.x/get- started/) is a query language that is used in the new versions of Influx. It is not similar to InfluxQL and doesn't use SQL syntax. ### Query example¶ from(bucket: "example-bucket") |> range(start: -1d) |> filter(fn: (r) => r._measurement == "example-measurement") |> mean() |> yield(name: "_results") Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Installation/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * Installation [ Installation ](./) Table of contents * Windows and MacOS installer * ZIP archive * Debian Package * RPM Package * Automatic updates * Activate license * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Windows and MacOS installer * ZIP archive * Debian Package * RPM Package * Automatic updates * Activate license 1. [DBeaver](/docs/dbeaver) 2. Getting started # Installation The installation process depends on the distribution type and your operating system. DBeaver supports the following operating systems: * **Microsoft Windows** : Windows 10 or later versions. * **Windows Server** : Windows Server 2016 or later versions. * **macOS** : macOS 11 or later versions. * **Linux** : Most modern distributions. For downloading the product, please visit the appropriate links below: * [DBeaver PRO Products](https://dbeaver.com/download/). * [DBeaver Community Edition](https://dbeaver.io/download/#requirements). Info You can also install DBeaver as a plugin in Eclipse-based IDEs: * With **Eclipse Marketplace** \- open the Eclipse Marketplace, search for [DBeaver](https://marketplace.eclipse.org/content/dbeaver), then drag the Install button into your Eclipse IDE. Follow the installation wizard to accept licenses and restart Eclipse. * With the **Install New Software** wizard - from the Eclipse main menu, select **Help - > Install New Software**, paste `https://dbeaver.com/update/ee/latest/` into the **Work with** field, and press **Enter**. ## Windows and MacOS installer¶ The installer distribution is the recommended method for installing DBeaver on Windows and MacOS. It includes all necessary dependencies. Additionally, the installer automatically upgrades DBeaver to the new version if a previous version is already installed. To install DBeaver, run the installer executable and follow the on-screen instructions. Note * The installer does not modify any system settings or the Java installation. * The included JDK is accessible only to DBeaver. * DBeaver includes OpenJDK, which is an open-source version of Java. This means you do not need to purchase a separate Java license to use DBeaver. ## ZIP archive¶ To install DBeaver manually without using an installer: 1. Extract the contents of the archive. Note * Do not unzip the archive over a previous version of DBeaver. If you already have any version of DBeaver extracted in the same location, remove it before unzipping the new version. * All configurations, scripts, and other necessary data are stored in a separate location (usually in the user's home directory), so uninstalling the program does not affect them. 2. Run the **dbeaver** executable. ## Debian Package¶ To install DBeaver using a Debian package: 1. Run `sudo dpkg -i dbeaver-.deb`. 2. Execute `dbeaver &`. ## RPM Package¶ To install DBeaver using an RPM package: 1. Run `sudo rpm -ivh dbeaver-.rpm`. 2. Execute `dbeaver &`. Note To upgrade DBeaver to a newer version, use the `-Uvh` parameter. For instance: `sudo rpm -Uvh dbeaver-.rpm`. ## Automatic updates¶ This feature is available only on Windows and macOS. Periodically, DBeaver automatically checks for new versions. If the check is not disabled and a new version is available, it will prompt you to decide whether to upgrade. If you choose to upgrade, the installer will be downloaded and launched automatically upon completion. Note DBeaver itself will be gracefully closed to avoid data loss. ## Activate license¶ After installation, activate DBeaver to use commercial features. Info For details, see [Import license](../How-to-Import-License/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Integrated-Security/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * Integrated security [ Integrated security ](./) Table of contents * Deleting the password * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Deleting the password 1. [DBeaver](/docs/dbeaver) 2. [Security](/docs/dbeaver/Security-in-DBeaver-PRO) 3. Password secure storage # Integrated security Note This feature is available in Community, [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. Integrated security uses your operating system's built-in keyring to store passwords securely. The provider generates a user-specific 'master' password and saves it in the OS keyring. Only users who can log into the operating system account can access the secure storage. For more information on setting up integrated security, refer to your operating system's documentation: * [OS X Keystore](https://support.apple.com/guide/keychain-access/welcome/mac) * [Windows Integration](https://support.microsoft.com/en-us/windows/accessing-credential-manager-1b5c916a-6a16-889f-8581-fc16e8165ac0) * Linux Integration (varies by distribution) ## Deleting the password¶ 1. Navigate to **Window - > Preferences -> General -> Security -> Secure Storage**. 2. Select the **Contents** tab and click **Delete**. 3. Confirm your action when prompted. 4. Restart DBeaver to apply the changes. Warning Deleting the password will permanently erase all saved credentials. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Invalidate-and-Reconnect-to-Database/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * Invalidate and reconnect [ Invalidate and reconnect ](./) Table of contents * Invalidate a database connection * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Invalidate a database connection 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Invalidate and reconnect ## Invalidate a database connection¶ You might need to invalidate a database connection and then reconnect to it again in cases such as where the connection to the server is temporarily lost, etc. To invalidate a database connection and then reconnect to the database, click the database connection in the Database Navigator or Projects view, and then click the **Invalidate/Reconnect** button in the toolbar or **Database - > Invalidate/Reconnect** on the main menu: ![](../images/ug/Invalidate-Reconnect.png) You can also right-click the connection and click **Invalidate/Reconnect** on the context menu. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/JDBC-Time-Zones/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](./) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Driver settings # JDBC time zones ID | Display Name | GMT shift ---|---|--- Africa/Abidjan | Greenwich Mean Time | 0.0 Africa/Accra | Ghana Mean Time | 0.0 Africa/Addis_Ababa | Eastern African Time | 3.0 Africa/Algiers | Central European Time | 1.0 Africa/Asmara | Eastern African Time | 3.0 Africa/Asmera | Eastern African Time | 3.0 Africa/Bamako | Greenwich Mean Time | 0.0 Africa/Bangui | Western African Time | 1.0 Africa/Banjul | Greenwich Mean Time | 0.0 Africa/Bissau | Greenwich Mean Time | 0.0 Africa/Blantyre | Central African Time | 2.0 Africa/Brazzaville | Western African Time | 1.0 Africa/Bujumbura | Central African Time | 2.0 Africa/Cairo | Eastern European Time | 2.0 Africa/Casablanca | Western European Time | 0.0 Africa/Ceuta | Central European Time | 1.0 Africa/Conakry | Greenwich Mean Time | 0.0 Africa/Dakar | Greenwich Mean Time | 0.0 Africa/Dar_es_Salaam | Eastern African Time | 3.0 Africa/Djibouti | Eastern African Time | 3.0 Africa/Douala | Western African Time | 1.0 Africa/El_Aaiun | Western European Time | 0.0 Africa/Freetown | Greenwich Mean Time | 0.0 Africa/Gaborone | Central African Time | 2.0 Africa/Harare | Central African Time | 2.0 Africa/Johannesburg | South Africa Standard Time | 2.0 Africa/Juba | Eastern African Time | 3.0 Africa/Kampala | Eastern African Time | 3.0 Africa/Khartoum | Eastern African Time | 3.0 Africa/Kigali | Central African Time | 2.0 Africa/Kinshasa | Western African Time | 1.0 Africa/Lagos | Western African Time | 1.0 Africa/Libreville | Western African Time | 1.0 Africa/Lome | Greenwich Mean Time | 0.0 Africa/Luanda | Western African Time | 1.0 Africa/Lubumbashi | Central African Time | 2.0 Africa/Lusaka | Central African Time | 2.0 Africa/Malabo | Western African Time | 1.0 Africa/Maputo | Central African Time | 2.0 Africa/Maseru | South Africa Standard Time | 2.0 Africa/Mbabane | South Africa Standard Time | 2.0 Africa/Mogadishu | Eastern African Time | 3.0 Africa/Monrovia | Greenwich Mean Time | 0.0 Africa/Nairobi | Eastern African Time | 3.0 Africa/Ndjamena | Western African Time | 1.0 Africa/Niamey | Western African Time | 1.0 Africa/Nouakchott | Greenwich Mean Time | 0.0 Africa/Ouagadougou | Greenwich Mean Time | 0.0 Africa/Porto-Novo | Western African Time | 1.0 Africa/Sao_Tome | Greenwich Mean Time | 0.0 Africa/Timbuktu | Greenwich Mean Time | 0.0 Africa/Tripoli | Eastern European Time | 2.0 Africa/Tunis | Central European Time | 1.0 Africa/Windhoek | Western African Time | 1.0 America/Adak | Hawaii Standard Time | -10.0 America/Anchorage | Alaska Standard Time | -9.0 America/Anguilla | Atlantic Standard Time | -4.0 America/Antigua | Atlantic Standard Time | -4.0 America/Araguaina | Brasilia Time | -3.0 America/Argentina/Buenos_Aires | Argentine Time | -3.0 America/Argentina/Catamarca | Argentine Time | -3.0 America/Argentina/ComodRivadavia | Argentine Time | -3.0 America/Argentina/Cordoba | Argentine Time | -3.0 America/Argentina/Jujuy | Argentine Time | -3.0 America/Argentina/La_Rioja | Argentine Time | -3.0 America/Argentina/Mendoza | Argentine Time | -3.0 America/Argentina/Rio_Gallegos | Argentine Time | -3.0 America/Argentina/Salta | Argentine Time | -3.0 America/Argentina/San_Juan | Argentine Time | -3.0 America/Argentina/San_Luis | Argentine Time | -3.0 America/Argentina/Tucuman | Argentine Time | -3.0 America/Argentina/Ushuaia | Argentine Time | -3.0 America/Aruba | Atlantic Standard Time | -4.0 America/Asuncion | Paraguay Time | -4.0 America/Atikokan | Eastern Standard Time | -5.0 America/Atka | Hawaii Standard Time | -10.0 America/Bahia | Brasilia Time | -3.0 America/Bahia_Banderas | Central Standard Time | -6.0 America/Barbados | Atlantic Standard Time | -4.0 America/Belem | Brasilia Time | -3.0 America/Belize | Central Standard Time | -6.0 America/Blanc-Sablon | Atlantic Standard Time | -4.0 America/Boa_Vista | Amazon Time | -4.0 America/Bogota | Colombia Time | -5.0 America/Boise | Mountain Standard Time | -7.0 America/Buenos_Aires | Argentine Time | -3.0 America/Cambridge_Bay | Mountain Standard Time | -7.0 America/Campo_Grande | Amazon Time | -4.0 America/Cancun | Eastern Standard Time | -5.0 America/Caracas | Venezuela Time | -4.0 America/Catamarca | Argentine Time | -3.0 America/Cayenne | French Guiana Time | -3.0 America/Cayman | Eastern Standard Time | -5.0 America/Chicago | Central Standard Time | -6.0 America/Chihuahua | Mountain Standard Time | -7.0 America/Coral_Harbour | Eastern Standard Time | -5.0 America/Cordoba | Argentine Time | -3.0 America/Costa_Rica | Central Standard Time | -6.0 America/Creston | Mountain Standard Time | -7.0 America/Cuiaba | Amazon Time | -4.0 America/Curacao | Atlantic Standard Time | -4.0 America/Danmarkshavn | Greenwich Mean Time | 0.0 America/Dawson | Pacific Standard Time | -8.0 America/Dawson_Creek | Mountain Standard Time | -7.0 America/Denver | Mountain Standard Time | -7.0 America/Detroit | Eastern Standard Time | -5.0 America/Dominica | Atlantic Standard Time | -4.0 America/Edmonton | Mountain Standard Time | -7.0 America/Eirunepe | Acre Time | -5.0 America/El_Salvador | Central Standard Time | -6.0 America/Ensenada | Pacific Standard Time | -8.0 America/Fort_Nelson | Mountain Standard Time | -7.0 America/Fort_Wayne | Eastern Standard Time | -5.0 America/Fortaleza | Brasilia Time | -3.0 America/Glace_Bay | Atlantic Standard Time | -4.0 America/Godthab | Western Greenland Time | -3.0 America/Goose_Bay | Atlantic Standard Time | -4.0 America/Grand_Turk | Atlantic Standard Time | -4.0 America/Grenada | Atlantic Standard Time | -4.0 America/Guadeloupe | Atlantic Standard Time | -4.0 America/Guatemala | Central Standard Time | -6.0 America/Guayaquil | Ecuador Time | -5.0 America/Guyana | Guyana Time | -4.0 America/Halifax | Atlantic Standard Time | -4.0 America/Havana | Cuba Standard Time | -5.0 America/Hermosillo | Mountain Standard Time | -7.0 America/Indiana/Indianapolis | Eastern Standard Time | -5.0 America/Indiana/Knox | Central Standard Time | -6.0 America/Indiana/Marengo | Eastern Standard Time | -5.0 America/Indiana/Petersburg | Eastern Standard Time | -5.0 America/Indiana/Tell_City | Central Standard Time | -6.0 America/Indiana/Vevay | Eastern Standard Time | -5.0 America/Indiana/Vincennes | Eastern Standard Time | -5.0 America/Indiana/Winamac | Eastern Standard Time | -5.0 America/Indianapolis | Eastern Standard Time | -5.0 America/Inuvik | Mountain Standard Time | -7.0 America/Iqaluit | Eastern Standard Time | -5.0 America/Jamaica | Eastern Standard Time | -5.0 America/Jujuy | Argentine Time | -3.0 America/Juneau | Alaska Standard Time | -9.0 America/Kentucky/Louisville | Eastern Standard Time | -5.0 America/Kentucky/Monticello | Eastern Standard Time | -5.0 America/Knox_IN | Central Standard Time | -6.0 America/Kralendijk | Atlantic Standard Time | -4.0 America/La_Paz | Bolivia Time | -4.0 America/Lima | Peru Time | -5.0 America/Los_Angeles | Pacific Standard Time | -8.0 America/Louisville | Eastern Standard Time | -5.0 America/Lower_Princes | Atlantic Standard Time | -4.0 America/Maceio | Brasilia Time | -3.0 America/Managua | Central Standard Time | -6.0 America/Manaus | Amazon Time | -4.0 America/Marigot | Atlantic Standard Time | -4.0 America/Martinique | Atlantic Standard Time | -4.0 America/Matamoros | Central Standard Time | -6.0 America/Mazatlan | Mountain Standard Time | -7.0 America/Mendoza | Argentine Time | -3.0 America/Menominee | Central Standard Time | -6.0 America/Merida | Central Standard Time | -6.0 America/Metlakatla | Alaska Standard Time | -9.0 America/Mexico_City | Central Standard Time | -6.0 America/Miquelon | Pierre & Miquelon Standard Time | -3.0 America/Moncton | Atlantic Standard Time | -4.0 America/Monterrey | Central Standard Time | -6.0 America/Montevideo | Uruguay Time | -3.0 America/Montreal | Eastern Standard Time | -5.0 America/Montserrat | Atlantic Standard Time | -4.0 America/Nassau | Eastern Standard Time | -5.0 America/New_York | Eastern Standard Time | -5.0 America/Nipigon | Eastern Standard Time | -5.0 America/Nome | Alaska Standard Time | -9.0 America/Noronha | Fernando de Noronha Time | -2.0 America/North_Dakota/Beulah | Central Standard Time | -6.0 America/North_Dakota/Center | Central Standard Time | -6.0 America/North_Dakota/New_Salem | Central Standard Time | -6.0 America/Ojinaga | Mountain Standard Time | -7.0 America/Panama | Eastern Standard Time | -5.0 America/Pangnirtung | Eastern Standard Time | -5.0 America/Paramaribo | Suriname Time | -3.0 America/Phoenix | Mountain Standard Time | -7.0 America/Port-au-Prince | Eastern Standard Time | -5.0 America/Port_of_Spain | Atlantic Standard Time | -4.0 America/Porto_Acre | Acre Time | -5.0 America/Porto_Velho | Amazon Time | -4.0 America/Puerto_Rico | Atlantic Standard Time | -4.0 America/Punta_Arenas | GMT-03:00 | -3.0 America/Rainy_River | Central Standard Time | -6.0 America/Rankin_Inlet | Central Standard Time | -6.0 America/Recife | Brasilia Time | -3.0 America/Regina | Central Standard Time | -6.0 America/Resolute | Central Standard Time | -6.0 America/Rio_Branco | Acre Time | -5.0 America/Rosario | Argentine Time | -3.0 America/Santa_Isabel | Pacific Standard Time | -8.0 America/Santarem | Brasilia Time | -3.0 America/Santiago | Chile Time | -4.0 America/Santo_Domingo | Atlantic Standard Time | -4.0 America/Sao_Paulo | Brasilia Time | -3.0 America/Scoresbysund | Eastern Greenland Time | -1.0 America/Shiprock | Mountain Standard Time | -7.0 America/Sitka | Alaska Standard Time | -9.0 America/St_Barthelemy | Atlantic Standard Time | -4.0 America/St_Johns | Newfoundland Standard Time | -3.5 America/St_Kitts | Atlantic Standard Time | -4.0 America/St_Lucia | Atlantic Standard Time | -4.0 America/St_Thomas | Atlantic Standard Time | -4.0 America/St_Vincent | Atlantic Standard Time | -4.0 America/Swift_Current | Central Standard Time | -6.0 America/Tegucigalpa | Central Standard Time | -6.0 America/Thule | Atlantic Standard Time | -4.0 America/Thunder_Bay | Eastern Standard Time | -5.0 America/Tijuana | Pacific Standard Time | -8.0 America/Toronto | Eastern Standard Time | -5.0 America/Tortola | Atlantic Standard Time | -4.0 America/Vancouver | Pacific Standard Time | -8.0 America/Virgin | Atlantic Standard Time | -4.0 America/Whitehorse | Pacific Standard Time | -8.0 America/Winnipeg | Central Standard Time | -6.0 America/Yakutat | Alaska Standard Time | -9.0 America/Yellowknife | Mountain Standard Time | -7.0 Antarctica/Casey | Australian Western Standard Time | 11.0 Antarctica/Davis | Davis Time | 7.0 Antarctica/DumontDUrville | Dumont-d'Urville Time | 10.0 Antarctica/Macquarie | Macquarie Island Standard Time | 11.0 Antarctica/Mawson | Mawson Time | 5.0 Antarctica/McMurdo | New Zealand Standard Time | 12.0 Antarctica/Palmer | Chile Time | -3.0 Antarctica/Rothera | Rothera Time | -3.0 Antarctica/South_Pole | New Zealand Standard Time | 12.0 Antarctica/Syowa | Syowa Time | 3.0 Antarctica/Troll | Coordinated Universal Time | 0.0 Antarctica/Vostok | Vostok Time | 6.0 Arctic/Longyearbyen | Central European Time | 1.0 Asia/Aden | Arabia Standard Time | 3.0 Asia/Almaty | Alma-Ata Time | 6.0 Asia/Amman | Eastern European Time | 2.0 Asia/Anadyr | Anadyr Time | 12.0 Asia/Aqtau | Aqtau Time | 5.0 Asia/Aqtobe | Aqtobe Time | 5.0 Asia/Ashgabat | Turkmenistan Time | 5.0 Asia/Ashkhabad | Turkmenistan Time | 5.0 Asia/Atyrau | GMT+05:00 | 5.0 Asia/Baghdad | Arabia Standard Time | 3.0 Asia/Bahrain | Arabia Standard Time | 3.0 Asia/Baku | Azerbaijan Time | 4.0 Asia/Bangkok | Indochina Time | 7.0 Asia/Barnaul | GMT+07:00 | 7.0 Asia/Beirut | Eastern European Time | 2.0 Asia/Bishkek | Kirgizstan Time | 6.0 Asia/Brunei | Brunei Time | 8.0 Asia/Calcutta | India Standard Time | 5.5 Asia/Chita | Yakutsk Time | 9.0 Asia/Choibalsan | Choibalsan Time | 8.0 Asia/Chongqing | China Standard Time | 8.0 Asia/Chungking | China Standard Time | 8.0 Asia/Colombo | India Standard Time | 5.5 Asia/Dacca | Bangladesh Time | 6.0 Asia/Damascus | Eastern European Time | 2.0 Asia/Dhaka | Bangladesh Time | 6.0 Asia/Dili | Timor-Leste Time | 9.0 Asia/Dubai | Gulf Standard Time | 4.0 Asia/Dushanbe | Tajikistan Time | 5.0 Asia/Famagusta | GMT+03:00 | 3.0 Asia/Gaza | Eastern European Time | 2.0 Asia/Harbin | China Standard Time | 8.0 Asia/Hebron | Eastern European Time | 2.0 Asia/Ho_Chi_Minh | Indochina Time | 7.0 Asia/Hong_Kong | Hong Kong Time | 8.0 Asia/Hovd | Hovd Time | 7.0 Asia/Irkutsk | Irkutsk Time | 8.0 Asia/Istanbul | Eastern European Time | 3.0 Asia/Jakarta | West Indonesia Time | 7.0 Asia/Jayapura | East Indonesia Time | 9.0 Asia/Jerusalem | Israel Standard Time | 2.0 Asia/Kabul | Afghanistan Time | 4.5 Asia/Kamchatka | Petropavlovsk-Kamchatski Time | 12.0 Asia/Karachi | Pakistan Time | 5.0 Asia/Kashgar | Xinjiang Standard Time | 6.0 Asia/Kathmandu | Nepal Time | 5.75 Asia/Katmandu | Nepal Time | 5.75 Asia/Khandyga | Yakutsk Time | 9.0 Asia/Kolkata | India Standard Time | 5.5 Asia/Krasnoyarsk | Krasnoyarsk Time | 7.0 Asia/Kuala_Lumpur | Malaysia Time | 8.0 Asia/Kuching | Malaysia Time | 8.0 Asia/Kuwait | Arabia Standard Time | 3.0 Asia/Macao | China Standard Time | 8.0 Asia/Macau | China Standard Time | 8.0 Asia/Magadan | Magadan Time | 11.0 Asia/Makassar | Central Indonesia Time | 8.0 Asia/Manila | Philippines Time | 8.0 Asia/Muscat | Gulf Standard Time | 4.0 Asia/Nicosia | Eastern European Time | 2.0 Asia/Novokuznetsk | Krasnoyarsk Time | 7.0 Asia/Novosibirsk | Novosibirsk Time | 7.0 Asia/Omsk | Omsk Time | 6.0 Asia/Oral | Oral Time | 5.0 Asia/Phnom_Penh | Indochina Time | 7.0 Asia/Pontianak | West Indonesia Time | 7.0 Asia/Pyongyang | Korea Standard Time | 8.5 Asia/Qatar | Arabia Standard Time | 3.0 Asia/Qyzylorda | Qyzylorda Time | 6.0 Asia/Rangoon | Myanmar Time | 6.5 Asia/Riyadh | Arabia Standard Time | 3.0 Asia/Saigon | Indochina Time | 7.0 Asia/Sakhalin | Sakhalin Time | 11.0 Asia/Samarkand | Uzbekistan Time | 5.0 Asia/Seoul | Korea Standard Time | 9.0 Asia/Shanghai | China Standard Time | 8.0 Asia/Singapore | Singapore Time | 8.0 Asia/Srednekolymsk | Srednekolymsk Time | 11.0 Asia/Taipei | China Standard Time | 8.0 Asia/Tashkent | Uzbekistan Time | 5.0 Asia/Tbilisi | Georgia Time | 4.0 Asia/Tehran | Iran Standard Time | 3.5 Asia/Tel_Aviv | Israel Standard Time | 2.0 Asia/Thimbu | Bhutan Time | 6.0 Asia/Thimphu | Bhutan Time | 6.0 Asia/Tokyo | Japan Standard Time | 9.0 Asia/Tomsk | GMT+07:00 | 7.0 Asia/Ujung_Pandang | Central Indonesia Time | 8.0 Asia/Ulaanbaatar | Ulaanbaatar Time | 8.0 Asia/Ulan_Bator | Ulaanbaatar Time | 8.0 Asia/Urumqi | Xinjiang Standard Time | 6.0 Asia/Ust-Nera | Ust-Nera Time | 10.0 Asia/Vientiane | Indochina Time | 7.0 Asia/Vladivostok | Vladivostok Time | 10.0 Asia/Yakutsk | Yakutsk Time | 9.0 Asia/Yangon | Myanmar Time | 6.5 Asia/Yekaterinburg | Yekaterinburg Time | 5.0 Asia/Yerevan | Armenia Time | 4.0 Atlantic/Azores | Azores Time | -1.0 Atlantic/Bermuda | Atlantic Standard Time | -4.0 Atlantic/Canary | Western European Time | 0.0 Atlantic/Cape_Verde | Cape Verde Time | -1.0 Atlantic/Faeroe | Western European Time | 0.0 Atlantic/Faroe | Western European Time | 0.0 Atlantic/Jan_Mayen | Central European Time | 1.0 Atlantic/Madeira | Western European Time | 0.0 Atlantic/Reykjavik | Greenwich Mean Time | 0.0 Atlantic/South_Georgia | South Georgia Standard Time | -2.0 Atlantic/St_Helena | Greenwich Mean Time | 0.0 Atlantic/Stanley | Falkland Is. Time | -3.0 Australia/ACT | Australian Eastern Standard Time (New South Wales) | 10.0 Australia/Adelaide | Australian Central Standard Time (South Australia) | 9.5 Australia/Brisbane | Australian Eastern Standard Time (Queensland) | 10.0 Australia/Broken_Hill | Australian Central Standard Time (South Australia/New South Wales) | 9.5 Australia/Canberra | Australian Eastern Standard Time (New South Wales) | 10.0 Australia/Currie | Australian Eastern Standard Time (New South Wales) | 10.0 Australia/Darwin | Australian Central Standard Time (Northern Territory) | 9.5 Australia/Eucla | Australian Central Western Standard Time | 8.75 Australia/Hobart | Australian Eastern Standard Time (Tasmania) | 10.0 Australia/LHI | Lord Howe Standard Time | 10.5 Australia/Lindeman | Australian Eastern Standard Time (Queensland) | 10.0 Australia/Lord_Howe | Lord Howe Standard Time | 10.5 Australia/Melbourne | Australian Eastern Standard Time (Victoria) | 10.0 Australia/NSW | Australian Eastern Standard Time (New South Wales) | 10.0 Australia/North | Australian Central Standard Time (Northern Territory) | 9.5 Australia/Perth | Australian Western Standard Time | 8.0 Australia/Queensland | Australian Eastern Standard Time (Queensland) | 10.0 Australia/South | Australian Central Standard Time (South Australia) | 9.5 Australia/Sydney | Australian Eastern Standard Time (New South Wales) | 10.0 Australia/Tasmania | Australian Eastern Standard Time (Tasmania) | 10.0 Australia/Victoria | Australian Eastern Standard Time (Victoria) | 10.0 Australia/West | Australian Western Standard Time | 8.0 Australia/Yancowinna | Australian Central Standard Time (South Australia/New South Wales) | 9.5 Brazil/Acre | Acre Time | -5.0 Brazil/DeNoronha | Fernando de Noronha Time | -2.0 Brazil/East | Brasilia Time | -3.0 Brazil/West | Amazon Time | -4.0 CET | Central European Time | 1.0 CST6CDT | Central Standard Time | -6.0 Canada/Atlantic | Atlantic Standard Time | -4.0 Canada/Central | Central Standard Time | -6.0 Canada/East-Saskatchewan | Central Standard Time | -6.0 Canada/Eastern | Eastern Standard Time | -5.0 Canada/Mountain | Mountain Standard Time | -7.0 Canada/Newfoundland | Newfoundland Standard Time | -3.5 Canada/Pacific | Pacific Standard Time | -8.0 Canada/Saskatchewan | Central Standard Time | -6.0 Canada/Yukon | Pacific Standard Time | -8.0 Chile/Continental | Chile Time | -4.0 Chile/EasterIsland | Easter Is. Time | -6.0 Cuba | Cuba Standard Time | -5.0 EET | Eastern European Time | 2.0 EST5EDT | Eastern Standard Time | -5.0 Egypt | Eastern European Time | 2.0 Eire | Greenwich Mean Time | 0.0 Etc/GMT | Greenwich Mean Time | 0.0 Etc/GMT+0 | Greenwich Mean Time | 0.0 Etc/GMT+1 | GMT-01:00 | -1.0 Etc/GMT+10 | GMT-10:00 | -10.0 Etc/GMT+11 | GMT-11:00 | -11.0 Etc/GMT+12 | GMT-12:00 | -12.0 Etc/GMT+2 | GMT-02:00 | -2.0 Etc/GMT+3 | GMT-03:00 | -3.0 Etc/GMT+4 | GMT-04:00 | -4.0 Etc/GMT+5 | GMT-05:00 | -5.0 Etc/GMT+6 | GMT-06:00 | -6.0 Etc/GMT+7 | GMT-07:00 | -7.0 Etc/GMT+8 | GMT-08:00 | -8.0 Etc/GMT+9 | GMT-09:00 | -9.0 Etc/GMT-0 | Greenwich Mean Time | 0.0 Etc/GMT-1 | GMT+01:00 | 1.0 Etc/GMT-10 | GMT+10:00 | 10.0 Etc/GMT-11 | GMT+11:00 | 11.0 Etc/GMT-12 | GMT+12:00 | 12.0 Etc/GMT-13 | GMT+13:00 | 13.0 Etc/GMT-14 | GMT+14:00 | 14.0 Etc/GMT-2 | GMT+02:00 | 2.0 Etc/GMT-3 | GMT+03:00 | 3.0 Etc/GMT-4 | GMT+04:00 | 4.0 Etc/GMT-5 | GMT+05:00 | 5.0 Etc/GMT-6 | GMT+06:00 | 6.0 Etc/GMT-7 | GMT+07:00 | 7.0 Etc/GMT-8 | GMT+08:00 | 8.0 Etc/GMT-9 | GMT+09:00 | 9.0 Etc/GMT0 | Greenwich Mean Time | 0.0 Etc/Greenwich | Greenwich Mean Time | 0.0 Etc/UCT | Coordinated Universal Time | 0.0 Etc/UTC | Coordinated Universal Time | 0.0 Etc/Universal | Coordinated Universal Time | 0.0 Etc/Zulu | Coordinated Universal Time | 0.0 Europe/Amsterdam | Central European Time | 1.0 Europe/Andorra | Central European Time | 1.0 Europe/Astrakhan | GMT+04:00 | 4.0 Europe/Athens | Eastern European Time | 2.0 Europe/Belfast | Greenwich Mean Time | 0.0 Europe/Belgrade | Central European Time | 1.0 Europe/Berlin | Central European Time | 1.0 Europe/Bratislava | Central European Time | 1.0 Europe/Brussels | Central European Time | 1.0 Europe/Bucharest | Eastern European Time | 2.0 Europe/Budapest | Central European Time | 1.0 Europe/Busingen | Central European Time | 1.0 Europe/Chisinau | Eastern European Time | 2.0 Europe/Copenhagen | Central European Time | 1.0 Europe/Dublin | Greenwich Mean Time | 0.0 Europe/Gibraltar | Central European Time | 1.0 Europe/Guernsey | Greenwich Mean Time | 0.0 Europe/Helsinki | Eastern European Time | 2.0 Europe/Isle_of_Man | Greenwich Mean Time | 0.0 Europe/Istanbul | Eastern European Time | 3.0 Europe/Jersey | Greenwich Mean Time | 0.0 Europe/Kaliningrad | Eastern European Time | 2.0 Europe/Kiev | Eastern European Time | 2.0 Europe/Kirov | GMT+03:00 | 3.0 Europe/Lisbon | Western European Time | 0.0 Europe/Ljubljana | Central European Time | 1.0 Europe/London | Greenwich Mean Time | 0.0 Europe/Luxembourg | Central European Time | 1.0 Europe/Madrid | Central European Time | 1.0 Europe/Malta | Central European Time | 1.0 Europe/Mariehamn | Eastern European Time | 2.0 Europe/Minsk | Moscow Standard Time | 3.0 Europe/Monaco | Central European Time | 1.0 Europe/Moscow | Moscow Standard Time | 3.0 Europe/Nicosia | Eastern European Time | 2.0 Europe/Oslo | Central European Time | 1.0 Europe/Paris | Central European Time | 1.0 Europe/Podgorica | Central European Time | 1.0 Europe/Prague | Central European Time | 1.0 Europe/Riga | Eastern European Time | 2.0 Europe/Rome | Central European Time | 1.0 Europe/Samara | Samara Time | 4.0 Europe/San_Marino | Central European Time | 1.0 Europe/Sarajevo | Central European Time | 1.0 Europe/Saratov | GMT+04:00 | 4.0 Europe/Simferopol | Moscow Standard Time | 3.0 Europe/Skopje | Central European Time | 1.0 Europe/Sofia | Eastern European Time | 2.0 Europe/Stockholm | Central European Time | 1.0 Europe/Tallinn | Eastern European Time | 2.0 Europe/Tirane | Central European Time | 1.0 Europe/Tiraspol | Eastern European Time | 2.0 Europe/Ulyanovsk | GMT+04:00 | 4.0 Europe/Uzhgorod | Eastern European Time | 2.0 Europe/Vaduz | Central European Time | 1.0 Europe/Vatican | Central European Time | 1.0 Europe/Vienna | Central European Time | 1.0 Europe/Vilnius | Eastern European Time | 2.0 Europe/Volgograd | Moscow Standard Time | 3.0 Europe/Warsaw | Central European Time | 1.0 Europe/Zagreb | Central European Time | 1.0 Europe/Zaporozhye | Eastern European Time | 2.0 Europe/Zurich | Central European Time | 1.0 GB | Greenwich Mean Time | 0.0 GB-Eire | Greenwich Mean Time | 0.0 GMT | Greenwich Mean Time | 0.0 GMT0 | Greenwich Mean Time | 0.0 Greenwich | Greenwich Mean Time | 0.0 Hongkong | Hong Kong Time | 8.0 Iceland | Greenwich Mean Time | 0.0 Indian/Antananarivo | Eastern African Time | 3.0 Indian/Chagos | Indian Ocean Territory Time | 6.0 Indian/Christmas | Christmas Island Time | 7.0 Indian/Cocos | Cocos Islands Time | 6.5 Indian/Comoro | Eastern African Time | 3.0 Indian/Kerguelen | French Southern & Antarctic Lands Time | 5.0 Indian/Mahe | Seychelles Time | 4.0 Indian/Maldives | Maldives Time | 5.0 Indian/Mauritius | Mauritius Time | 4.0 Indian/Mayotte | Eastern African Time | 3.0 Indian/Reunion | Reunion Time | 4.0 Iran | Iran Standard Time | 3.5 Israel | Israel Standard Time | 2.0 Jamaica | Eastern Standard Time | -5.0 Japan | Japan Standard Time | 9.0 Kwajalein | Marshall Islands Time | 12.0 Libya | Eastern European Time | 2.0 MET | Middle Europe Time | 1.0 MST7MDT | Mountain Standard Time | -7.0 Mexico/BajaNorte | Pacific Standard Time | -8.0 Mexico/BajaSur | Mountain Standard Time | -7.0 Mexico/General | Central Standard Time | -6.0 NZ | New Zealand Standard Time | 12.0 NZ-CHAT | Chatham Standard Time | 12.75 Navajo | Mountain Standard Time | -7.0 PRC | China Standard Time | 8.0 PST8PDT | Pacific Standard Time | -8.0 Pacific/Apia | West Samoa Standard Time | 13.0 Pacific/Auckland | New Zealand Standard Time | 12.0 Pacific/Bougainville | Bougainville Standard Time | 11.0 Pacific/Chatham | Chatham Standard Time | 12.75 Pacific/Chuuk | Chuuk Time | 10.0 Pacific/Easter | Easter Is. Time | -6.0 Pacific/Efate | Vanuatu Time | 11.0 Pacific/Enderbury | Phoenix Is. Time | 13.0 Pacific/Fakaofo | Tokelau Time | 13.0 Pacific/Fiji | Fiji Time | 12.0 Pacific/Funafuti | Tuvalu Time | 12.0 Pacific/Galapagos | Galapagos Time | -6.0 Pacific/Gambier | Gambier Time | -9.0 Pacific/Guadalcanal | Solomon Is. Time | 11.0 Pacific/Guam | Chamorro Standard Time | 10.0 Pacific/Honolulu | Hawaii Standard Time | -10.0 Pacific/Johnston | Hawaii Standard Time | -10.0 Pacific/Kiritimati | Line Is. Time | 14.0 Pacific/Kosrae | Kosrae Time | 11.0 Pacific/Kwajalein | Marshall Islands Time | 12.0 Pacific/Majuro | Marshall Islands Time | 12.0 Pacific/Marquesas | Marquesas Time | -9.5 Pacific/Midway | Samoa Standard Time | -11.0 Pacific/Nauru | Nauru Time | 12.0 Pacific/Niue | Niue Time | -11.0 Pacific/Norfolk | Norfolk Time | 11.0 Pacific/Noumea | New Caledonia Time | 11.0 Pacific/Pago_Pago | Samoa Standard Time | -11.0 Pacific/Palau | Palau Time | 9.0 Pacific/Pitcairn | Pitcairn Standard Time | -8.0 Pacific/Pohnpei | Pohnpei Time | 11.0 Pacific/Ponape | Pohnpei Time | 11.0 Pacific/Port_Moresby | Papua New Guinea Time | 10.0 Pacific/Rarotonga | Cook Is. Time | -10.0 Pacific/Saipan | Chamorro Standard Time | 10.0 Pacific/Samoa | Samoa Standard Time | -11.0 Pacific/Tahiti | Tahiti Time | -10.0 Pacific/Tarawa | Gilbert Is. Time | 12.0 Pacific/Tongatapu | Tonga Time | 13.0 Pacific/Truk | Chuuk Time | 10.0 Pacific/Wake | Wake Time | 12.0 Pacific/Wallis | Wallis & Futuna Time | 12.0 Pacific/Yap | Chuuk Time | 10.0 Poland | Central European Time | 1.0 Portugal | Western European Time | 0.0 ROK | Korea Standard Time | 9.0 Singapore | Singapore Time | 8.0 SystemV/AST4 | Atlantic Standard Time | -4.0 SystemV/AST4ADT | Atlantic Standard Time | -4.0 SystemV/CST6 | Central Standard Time | -6.0 SystemV/CST6CDT | Central Standard Time | -6.0 SystemV/EST5 | Eastern Standard Time | -5.0 SystemV/EST5EDT | Eastern Standard Time | -5.0 SystemV/HST10 | Hawaii Standard Time | -10.0 SystemV/MST7 | Mountain Standard Time | -7.0 SystemV/MST7MDT | Mountain Standard Time | -7.0 SystemV/PST8 | Pacific Standard Time | -8.0 SystemV/PST8PDT | Pacific Standard Time | -8.0 SystemV/YST9 | Alaska Standard Time | -9.0 SystemV/YST9YDT | Alaska Standard Time | -9.0 Turkey | Eastern European Time | 3.0 UCT | Coordinated Universal Time | 0.0 US/Alaska | Alaska Standard Time | -9.0 US/Aleutian | Hawaii Standard Time | -10.0 US/Arizona | Mountain Standard Time | -7.0 US/Central | Central Standard Time | -6.0 US/East-Indiana | Eastern Standard Time | -5.0 US/Eastern | Eastern Standard Time | -5.0 US/Hawaii | Hawaii Standard Time | -10.0 US/Indiana-Starke | Central Standard Time | -6.0 US/Michigan | Eastern Standard Time | -5.0 US/Mountain | Mountain Standard Time | -7.0 US/Pacific | Pacific Standard Time | -8.0 US/Pacific-New | Pacific Standard Time | -8.0 US/Samoa | Samoa Standard Time | -11.0 UTC | Coordinated Universal Time | 0.0 Universal | Coordinated Universal Time | 0.0 W-SU | Moscow Standard Time | 3.0 WET | Western European Time | 0.0 Zulu | Coordinated Universal Time | 0.0 Back to top --- # Source: https://dbeaver.com/docs/dbeaver/JDBC-Tracing/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](./) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Driver settings # JDBC tracing In some cases, custom JDBC drivers work incorrectly in DBeaver - they show the wrong metadata like table columns, constraints or foreign keys. It usually happens because the driver is not compliant with the JDBC API specification and DBeaver cannot correctly interpret the metadata provided by the driver. To understand what is going on inside the driver, you can enable JDBC tracing: 1. Find `dbeaver.ini` file. Tip Detailed instructions on finding `dbeaver.ini` are available in [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). 1. Add line `-Ddbeaver.jdbc.trace=true` in the end of `dbeaver.ini`. 2. Restart DBeaver. 3. Connect to your database and browse the metadata in the database navigator/object editors. 4. In DBeaver [Workspace](../Workspace-Location/) go to `.metadata` folder. 5. File `jdbc-api-trace.log` contains all JDBC API invocations and all queries with results. Analyzing contents of `jdbc-api-trace.log` you can understand what is wrong with the metadata. Attach the piece of the trace file in the GitHub ticket if you think that something is wrong on DBeaver's side. WARNING: disable JDBC tracing in your regular work. Enable it only for debugging. The trace generation decreases application performance and may produce huge log files. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Kerberos-Authentication/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * Kerberos [ Kerberos ](./) Table of contents * Supported databases * Settings * Extra configuration * Using the kinit * Using the keytab file * Windows specifics * Local Kerberos configuration file * Additional settings * Troubleshooting * Oracle JDBC driver and Kerberos authentication * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported databases * Settings * Extra configuration * Using the kinit * Using the keytab file * Windows specifics * Local Kerberos configuration file * Additional settings * Troubleshooting * Oracle JDBC driver and Kerberos authentication 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Database authentication models # Kerberos Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver includes support for Kerberos authentication, enabling secure connections to your databases. ![](../images/auth_methods/Kerberos/kerberos-authentication.png) Kerberos authentication is a secure method for verifying user identities over non-secure networks. It is widely used in various environments, especially in database management systems, to ensure that communication between the client and server remains encrypted and authenticated. This guide is designed to help you configure Kerberos authentication on the client machine, where DBeaver is installed. It assumes that the Kerberos Key Distribution Center (KDC) and the necessary server configurations have already been completed. ## Supported databases¶ * [AlloyDB](../Database-driver-AlloyDB-for-PostgreSQL/) * Cockroach * [Db2 for LUW](../Database-driver-IBM-Db2/) Note Kerberos authentication is only supported with [version 11.x of the Db2 driver](https://www.ibm.com/docs/en/db2/11.1.0). * EnterpriseDB (EDB) * Fujitsu * [Greenplum](../Database-driver-Greenplum/) * HANA * [MariaDB](../Database-driver-MariaDB/) * [MySQL](../Database-driver-MySQL/) * [Oracle](../Oracle/) * [PostgreSQL](../Database-driver-PostgreSQL/) * PrestoDB * PrestoSQL * [Redshift](../Database-driver-Amazon-Redshift/) * [Teradata](../Database-driver-Teradata/) * TimescaleDB * [Trino](../Database-driver-Trino/) * [Yellowbrick](../Database-driver-Yellowbrick/) * YugabyteDB ## Settings¶ The table below lists the basic settings required for Kerberos authentication in DBeaver. These settings are essential for establishing a secure connection to your database using Kerberos, providing user identification, authentication, and access control. Setting | Description ---|--- **Username** | Specifies the name of the user or role within the database. This is the identity under which you will connect to your database. **Kerberos user** | A unique identity in the Kerberos system to which Kerberos can assign tickets, enabling access to services that are Kerberos-aware. **Realm** | The domain over which a Kerberos authentication server can authenticate users, hosts, or services. It's often the uppercase version of the DNS domain name it oversees. **KDC Server** | The hostname of your Kerberos Key Distribution Center (KDC), which is a service that provides session tickets and keys within an Active Directory domain. **Password** | The password associated with your Kerberos user. This method involves directly entering your password. It's a simple, manual process suitable for environments where automated authentication methods are not preferred or available. Below are additional Kerberos authentication settings for advanced configuration: Extra configuration | Description ---|--- **Use kinit** | When selected, it indicates the use of the `kinit` tool on your machine, which obtains and caches an initial ticket-granting ticket. Generally, you only need to provide your Kerberos username when this option is selected. Selecting this option makes the **Password** field inactive because authentication is managed through the ticket obtained by `kinit`. **Use keytab** | A checkbox option for those who prefer to use a keytab file instead of manually entering a password. Selecting this option also makes the **Password** field inactive because the keytab file contains encrypted keys that the Kerberos system uses for authentication. **Custom krb5.conf** | Allows you to specify the path to your local Kerberos configuration file. This file contains settings that define the Kerberos realms, KDCs, and other parameters for your environment. **Debug Kerberos Connection** | A checkbox that, when selected, enables the logging of detailed Kerberos connection information in your [log files](../Log-files/). Note Some settings may be stored in a session cache. If you have updated the settings and still encounter connection issues, restarting DBeaver might be necessary to apply the changes effectively. ## Extra configuration¶ The **Extra configuration** section within DBeaver's connection settings offers advanced options for customizing the Kerberos. This section allows users to specify detailed settings, such as the use of a keytab file, `kinit` commands, or a custom `krb5.conf`/`krb5.ini` file. ### Using the kinit¶ The `kinit` command is a utility Kerberos provides to obtain and cache an initial ticket-granting ticket (TGT). In the context of using DBeaver, the `kinit` command streamlines the authentication process by obtaining and caching an initial ticket-granting ticket (TGT). This mechanism enables users to authenticate against Kerberos- enabled services, reducing the need for continuous password inputs during the session. To configure Kerberos authentication using `kinit` command, follow these steps: 1. Make sure you have a valid Kerberos ticket-granting ticket (TGT), which can be obtained using the `kinit` command. For a detailed guide, refer to the [official documentation](https://www.ibm.com/docs/en/aix/7.3?topic=k-kinit-command) on `kinit` command. 2. Specify the path to your `kinit` tool in the **Extra Configuration** section in the **Use kinit** field. 3. Try connecting to your database. With these settings, DBeaver will use the `kinit` command for authentication. ![](../images/auth_methods/Kerberos/kerberos-kinit-settings.png) ### Using the keytab file¶ A keytab is a file containing pairs of Kerberos principals and encrypted keys derived from the Kerberos password. It enables authentication to various remote systems using Kerberos without entering a password. In the context of using DBeaver, the keytab file simplifies the authentication process by requiring the user to provide all necessary credentials except the password. To configure Kerberos authentication using a keytab file, follow these steps: 1. Utilize the `ktutil` command-line utility to generate a keytab file. This involves adding entries for your principals along with their encrypted keys. For comprehensive instructions on creating a keytab file, consult the [official documentation](https://www.ibm.com/docs/en/pasc/1.1.1?topic=file-creating-kerberos-principal-keytab) on creating a Kerberos keytab file. 2. Specify the path to your keytab file in the **Extra Configuration** section in the **Use keytab** field. 3. Attempt to connect to your database. DBeaver will utilize the specified keytab file for authentication. ![](../images/auth_methods/Kerberos/kerberos-keytab-settings.png) #### Windows specifics¶ On Linux and macOS, `kinit` and keytab files are supported natively. However, Windows does not support these functionalities natively. To enable these features, Windows users need to install additional software. A key tool for Windows users is [MIT Kerberos](https://ist.mit.edu/mit- apps/kerberos-win) for Windows. It allows the use of `kinit` and provides utilities for managing keytab files, bridging the gap between Windows and Kerberos authentication standards. ### Local Kerberos configuration file¶ If you have a custom Kerberos configuration file (`krb5.conf`/`krb5.ini`), input the complete file path in the **Custom krb5.conf** field. The configuration file includes necessary configuration details such as KDCs and admin server locations for Kerberos realms, default values for the current Realm, and hostname to Kerberos realm mappings. If a custom configuration file path is provided, it is not necessary to fill in the standard authentication fields, as the configuration file contains all the required information. ## Additional settings¶ When configuring PrestoSQL and Trino connections, especially in environments that utilize Kerberos authentication and SSL, certain additional settings might be necessary for connection: Setting | Description ---|--- **Service name** | Add the Kerberos service name of the remote coordinator. **Use SSL from JKS** | Check this setting and manually add the file path to your `.jks` file if you need an SSL certificate from a JKS file. This is useful when the server's SSL certificate is not automatically trusted. If your JKS file is password-protected, add the password to the **SSL JKS Password** field to allow database to access the keystone. **SSL JKS Password** | For additional security, the JKS file is password-protected. Add the password to the "SSL JKS" field to allow database to access the keystone. ## Troubleshooting¶ ### Oracle JDBC driver and Kerberos authentication¶ When configuring Kerberos authentication for Oracle databases, it is important to be aware of compatibility issues with certain JDBC driver versions. Specifically, Oracle JDBC driver version 21 has been known to cause issues with Kerberos authentication, often not working with older configurations. To ensure Kerberos authentication functions properly with Oracle databases, it is recommended to use an older version of the Oracle JDBC driver. Versions 12.x or 19.x are known to be compatible and should be used for Kerberos authentication. By selecting one of these older driver versions, you can avoid the authentication problems introduced in version 21. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Kubernetes-configuration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * Kubernetes configuration [ Kubernetes configuration ](./) Table of contents * Setting up Kubernetes * Kubectl settings * Testing port forwarding * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting up Kubernetes * Kubectl settings * Testing port forwarding 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. Connection network options # Kubernetes configuration Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. In some scenarios, you may need to interact with databases that are part of a Kubernetes cluster. DBeaver offers a way to configure Kubernetes settings to facilitate this. Before proceeding, ensure that you meet the following prerequisites: * You must have the [kubectl](https://kubernetes.io/docs/tasks/tools/) tool installed on your local machine. * You need a Kubernetes [configuration file](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/). Use the local one or consult your administrator for access. ## Setting up Kubernetes¶ To set up a tunnel to a Kubernetes cluster in DBeaver, you need to configure the following settings: 1. Start [creating a new connection](../Create-Connection/). 2. Click on the plus (![](../images/plus-button.png)) button and select **Kubernetes**. ![](../images/ug/network/k8s/add-kubernetes.png) 3. After selecting, a **Kubernetes** tab will appear in the menu at the top. ![](../images/ug/network/k8s/connection-kubernetes.png) 4. In the **Kubernetes** tab, enter the necessary configuration details: Field | Description ---|--- Configuration | Specify the path to your Kubernetes configuration file. Context | Manually select a **kube-context** if your configuration offers multiple contexts for different clusters. The default setting is `default`. Namespace | The default value is `default`, but this may differ in managed Kubernetes environments. Obtain the correct namespace from your `kubectl` config. Resource | By clicking the **Find Resource** button ![](../images/ug/network/k8s/find-resource.png) next to the field, a list of available services to connect to will open. From this list, you can select the service you wish to connect to. Port | Configure Kubernetes port forwarding by using `kubectl`. Info When clicking the dropdown menus in **Context** and **Namespace** , you can select settings directly from your `kubectl` config. 5. After configuring settings, click on **Test port forwarding** button to test whether all parameters are valid. Tip Use [network profiles](../Network-profiles/) to save and reuse your settings across multiple connections. ### Kubectl settings¶ The Kubernetes Command-Line Tool, `kubectl`, is essential for interacting with Kubernetes clusters and is integral to the functioning of DBeaver's Kubernetes features. Learn more in the [official Kubernetes documentation](https://kubernetes.io/docs/reference/kubectl/). To configure `kubectl` settings, you have two options: 1. Click on **Configuration** button on the Kubernetes connection settings page to access the `kubectl` settings. 2. Alternatively, navigate to **Window** -> **Preferences** -> **Connections** -> **Command Line Tools** -> **Kubernetes** to specify the path to your `kubectl` executable. ### Testing port forwarding¶ The **Test port forwarding** button utilizes the `kubectl port-forward` feature to enable secure access to applications running inside Pods from your local machine. This provides a secure way to interact with the application without exposing it to the outside world. Learn more in the [official Kubernetes documentation](https://kubernetes.io/docs/tasks/access-application- cluster/port-forward-access-application-cluster/). To test port forwarding: 1. Fill out the necessary Kubernetes settings as described in the previous section. 2. Click on the **Test port forwarding** button to initiate the port forwarding process. If the test is successful, this confirms that you can securely access the targeted Kubernetes resource from your local machine using the configured port settings. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/License-Administration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * License administration [ License administration ](./) Table of contents * Place the license file in predefined locations * Pass the license file via command line * Command line option * Configuration file option * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Place the license file in predefined locations * Pass the license file via command line * Command line option * Configuration file option 1. [DBeaver](/docs/dbeaver) 2. Licenses # License administration Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. You can automate the license management process in DBeaver, which is especially useful in multi-user or enterprise environments. ## Place the license file in predefined locations¶ 1. [Install](../Installation/) DBeaver 2. Save your license text to a file named either `.dbeaver-%PRODUCT_PREFIX%-license.dat` or `.dbeaver-%PRODUCT_PREFIX%-license.txt` Product name | Prefix ---|--- DBeaver [Lite](../Lite-Edition/) | le DBeaver [Enterprise](../Enterprise-Edition/) | ee DBeaver [Ultimate](../Ultimate-Edition/) | ue 3. Copy the license file to one of the following locations, depending on your operating system: * Windows: * `%HOMEPATH%\` * `%APPDATA%\DBeaverData\workspace6\.metadata\` * macOS: * `~/` (user home) * `~/Library/DBeaverData/workspace6/.metadata/` * Linux: * `~/` (user home) * `$XDG_DATA_HOME/DBeaverData/workspace6/.metadata/` 4. Launch DBeaver from the Start Menu or your preferred shortcut. Tip Using predefined locations allows DBeaver to detect and import the license automatically on startup. ## Pass the license file via command line¶ You can pass the license path directly through the command line or the configuration file. ### Command line option¶ Add the parameter `-license ` to the DBeaver launch command or shortcut. Example dbeaver -license "C:\licenses\dbeaver-ee-license.dat" For a full list of available CLI parameters, see the [Command line](../Command-Line/) reference. ### Configuration file option¶ You can also add this parameter to your `dbeaver.ini` file: -license "C:\licenses\dbeaver-ee-license.dat" Tip For details on locating `dbeaver.ini`, see [Configuration files in DBeaver](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Lite-Edition/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * Lite edition [ Lite edition ](./) Table of contents * Lite Edition features * Subscription model * Integrated database drivers * Supported databases * Relational databases * Non-Relational databases * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Lite Edition features * Subscription model * Integrated database drivers * Supported databases * Relational databases * Non-Relational databases 1. [DBeaver](/docs/dbeaver) 2. [About DBeaver](/docs/dbeaver/Enterprise-Edition) 3. Editions # Lite edition [DBeaver Lite Edition](https://dbeaver.com/dbeaver-lite/) is tailored for users who need basic tools to work with databases. This version offers a streamlined interface that focuses on simple database tasks like viewing data and running queries. It is especially useful for business users who need an easy-to-use tool. Note The DBeaver Lite Edition is designed for individual use only. ## Lite Edition features¶ Key features included in the Lite Edition are designed to support everyday database tasks with minimal hassle: * **Data Visualization** * **Color coding and highlighting** : Simplifies data analysis by color-coding and highlighting table rows and fields based on conditions. [Learn more](../SQL-Code-Editor/). * **Data filtering and sorting** : Provides tools to filter and sort data directly within the database interface. [Learn more](../Data-Filters/). * **Analytical charts** : Offers tool for creating analytical charts to represent data visually. [Learn more](../Managing-Charts/). * **Entity relationship diagrams** : Visualize database schemas through entity-relationship diagrams. [Learn more](../ER-Diagrams/). * **Data import/export** * **Office formats support (XLS)** : Enables users to import and export data in Office formats, specifically Excel (`XLS`). [Learn more](../Data-transfer/). * **Query development** * **AI Assistant in SQL Editor** : Integrates an AI Assistant and AI Chat to offer guidance and automation within the SQL Editor. [Learn more](../AI-Smart-Assistance/). * **Search in query history** : Enables searching through previous queries for easier management and reuse. * **Spelling** : Provides spelling verification to improve the quality and accuracy of SQL scripts. [Learn more](../Spelling/). * **Visual query builder** : Provides a graphical interface to construct SQL queries without writing code. [Learn more](../Visual-Query-Builder/). * **Comprehensive security support** : Ensures secure access to databases within your environment, even if they are protected by Single Sign-On (SSO), Kerberos, SSL, and other security measures. ### Subscription model¶ The DBeaver Lite Edition is offered as an annual subscription, which should be renewed to continue receiving updates and support. [Discover more about the DBeaver Lite Edition and subscribe](https://dbeaver.com/dbeaver-lite/). ### Integrated database drivers¶ The Lite Edition has a comprehensive set of JDBC drivers, offering connectivity to various databases without needing separate downloads and configurations. Additionally, a versatile ODBC driver is supported for broader database compatibility. Info For additional details on utilizing the ODBC driver, please consult the [ODBC- JDBC driver](../ODBC-JDBC-Driver/) article. ### Supported databases¶ The Lite Edition provides support for a wide range of databases. Below are tables listing the databases available and specifying whether the Lite Edition offers enhanced features compared to the Community Edition. * Enhanced features may include additional metadata capabilities, such as the ability to manage and interact with specific database objects unique to certain systems. For instance, managing **Roles** in Redshift. These features also cover various advanced authentication methods, and numerous other functionalities designed to improve security and data management. #### Relational databases¶ Database name | Enhanced features* compared to the Community Edition ---|--- **Altibase** | - **Apache Arrow** | Not available in Community Edition **Apache Calcite Avatica** | ✓ **Apache Kylin** | - **Aurora DSQL** | Not available in Community Edition **Azure SQL Server** | ✓ **Babelfish via TDS (beta)** | ✓ **CUBRID** | ✓ **Cache** | - [**ClickHouse**](../Clickhouse/) | - **CloudberryDB** | - [**ClickHouse (Legacy)**](../Clickhouse/) | ✓ [**CloudSQL - MySQL**](../Database-driver-MySQL-on-Google-Cloud/) | Not available in Community Edition [**CloudSQL - PostgreSQL**](../Database-driver-PostgreSQL-on-Google-Cloud/) | Not available in Community Edition [**CloudSQL - SQL Server**](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) | Not available in Community Edition **CockroachDB** | - **CrateDB** | - **CrateDB (Legacy)** | - [**Databricks**](../Database-driver-Databricks/) | ✓ **Dameng** | - [**Db2 for IBM i**](../Database-driver-IBM-Db2/) | ✓ [**Db2 for LUW**](../Database-driver-IBM-Db2/) | - [**Db2 for z/OS**](../Database-driver-IBM-Db2/) | ✓ **Denodo 8** | - **Derby Embedded** | - **Derby Server** | - **Dremio** | - **DuckDB** | - **EDB** | ✓ **Exasol** | ✓ **FerretDB** | Not available in Community Edition **Firebird** | ✓ [**Firestore**](../Database-driver-Firestore/) | Not available in Community Edition **Fujitsu Enterprise Postgres** | Not available in Community Edition **GaussDB** | - [**Google AlloyDB**](../Database-driver-AlloyDB-for-PostgreSQL/) | Not available in Community Edition **Google Cloud Spanner** | ✓ [**Greenplum**](../Database-driver-Greenplum/) | ✓ **Greengage** | Not available in Community Edition **H2 Embedded** | ✓ **H2 Embedded V.2** | - **H2 Server** | ✓ **H2GIS Embedded** | - **H2GIS Server** | - **HANA** | ✓ **HSQL Embedded** | - **HSQL Server** | - **Informix** | ✓ **Ingres** | - **InterSystems IRIS** | - **JDBCX** | - **Jennifer** | - **MS Access (UCanAccess)** | - [**MariaDB**](../Database-driver-MariaDB/) | ✓ **Materialize** | - **MaxDB** | - **Mimer SQL** | - **MonetDB** | - [**MySQL**](../Database-driver-MySQL/) | ✓ [**MySQL 5 (Legacy)**](../Database-driver-MySQL/) | ✓ **NDB Cluster** | - **NetSuite** | Not available in Community Edition [**Netezza**](../Database-driver-Netezza/) | ✓ **NuoDB** | - **ODBC** | Not available in Community Edition **OceanBase** | - **Ocient** | - **OmniSci (formerly MapD)** | - **OpenEdge** | - **OpenSearch** | ✓ [**Oracle**](../Oracle/) | ✓ **Pervasive SQL** | - [**PostgreSQL**](../Database-driver-PostgreSQL/) | ✓ **PrestoDB** | - **PrestoSQL** | - **Raima** | Not available in Community Edition [**Redshift**](../Database-driver-Amazon-Redshift/) | ✓ [**Redshift Serverless**](../Database-driver-Amazon-Redshift/) | ✓ **RisingWave** | - **SAP ASE jConnect** | - [**SQL Server**](../Database-driver-Microsoft-SQL-Server/) | ✓ [**SQL Server (Old driver, jTDS)**](../Database-driver-Microsoft-SQL-Server/) | ✓ [**SQLite**](../Database-driver-SQLite/) | ✓ [**SQLite Crypt**](../Database-driver-SQLite/) | Not available in Community Edition **SQream DB** | - [**Salesforce**](../Database-driver-Salesforce/) | Not available in Community Edition **Salesforce Data Cloud** | ✓ **SingleStore** | ✓ [**Snowflake**](../Snowflake/) | ✓ **StarRocks** | - **Sybase jConnect** | ✓ **Sybase jTDS** | ✓ [**Teradata**](../Database-driver-Teradata/) | ✓ **TiDB** | - [**Trino**](../Database-driver-Trino/) | - **Vertica** | ✓ **Virtuoso** | - [**Yellowbrick**](../Database-driver-Yellowbrick/) | - **YugabyteDB** | - #### Non-Relational databases¶ Database name | Enhanced features* compared to the Community Edition ---|--- **Apache Drill** | ✓ [**Apache Hive**](../Apache-Hive/) | ✓ **Apache Ignite** | - **Apache Kyuubi** | - **Apache Phoenix** | - **Apache Spark** | - [**Athena**](../Database-driver-Amazon-Athena/) | ✓ **Azure Cosmos DB for Cassandra** | Not available in Community Edition [**Azure Cosmos DB for MongoDB**](../Database-driver-CosmosDB/) | Not available in Community Edition [**Azure Cosmos DB for NoSQL**](../Database-driver-Azure-CosmosDB-for-NoSQL/) | Not available in Community Edition [**Cassandra**](../Cassandra/) | Not available in Community Edition **Cloudera Impala** | - **CouchDB** | Not available in Community Edition [**Couchbase**](../Couchbase/) | Not available in Community Edition [**Couchbase 5+**](../Couchbase/) | Not available in Community Edition [**CSV**](../Database-driver-CSV/) | + **DBF** | - [**DocumentDB**](../AWS-DocumentDB/) | Not available in Community Edition [**DynamoDB**](../AWS-DynamoDB/) | Not available in Community Edition **Elasticsearch** | ✓ **Gemfire XD** | - [**Google BigQuery**](../Database-driver-BigQuery/) | ✓ [**Google Cloud Bigtable**](../Google-Bigtable/) | Not available in Community Edition [**InfluxDB**](../InfluxDB/) | Not available in Community Edition [**InfluxDB 2**](../InfluxDB/) | Not available in Community Edition [**InfluxDB 3**](../InfluxDB/) | Not available in Community Edition [**Keyspaces**](../AWS-Keyspaces/) | Not available in Community Edition **Machbase** | - [**MongoDB**](../MongoDB/) | Not available in Community Edition [**Neo4j**](../Database-driver-Neo4j/) | Not available in Community Edition [**Neptune**](../Database-driver-Neptune/) | Not available in Community Edition **Open Distro Elasticsearch** | ✓ **OrientDB** | - [**Parquet**](../Database-driver-Parquet/) | Not available in Community Edition [**Redis**](../Redis/) | Not available in Community Edition **ScyllaDB** | Not available in Community Edition **SnappyData** | - **Solr** | - **TDengine** | ✓ **TDengine Cloud** | ✓ **TimescaleDB** | - [**Timestream**](../Database-driver-Amazon-Timestream/) | Not available in Community Edition [**XLSX**](../Database-driver-XLSX/) | Not available in Community Edition **Yugabyte CQL** | Not available in Community Edition Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Local-Client-Configuration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * Local client configuration [ Local client configuration ](./) Table of contents * Local Client configuration for Windows * Local Client configuration for Mac and Linux * Find a database installation path * Configure a local client in DBeaver on Mac and Linux * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Local Client configuration for Windows * Local Client configuration for Mac and Linux * Find a database installation path * Configure a local client in DBeaver on Mac and Linux 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Local client configuration This article provides instructions on how to configure a local database client for use with DBeaver. A local client refers to the database client software installed on your machine, allowing DBeaver to interact with your databases. This local installation is necessary for specific features like native [backup and restore](../Backup-Restore/) operations. Key points to consider: * In the **Community Edition** of DBeaver on Windows, local clients are downloaded from the internet when a remote client is selected in the **Local Client** options, typically during the first usage of database-specific tools such as backup, or restore functions. * Windows users with the [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/), or [Team](https://dbeaver.com/dbeaver-team-edition) editions enjoy a simplified process, as many local clients come pre-included with the software. * Mac and Linux users may need to perform additional steps to configure the local client. The exact procedure will vary depending on the system setup. ## Local Client configuration for Windows¶ Upon initial configuration, DBeaver will attempt to automatically identify the paths to local database clients in the Windows environment. If this process is unsuccessful, manual path configuration may be necessary. ## Local Client configuration for Mac and Linux¶ On macOS, DBeaver actively tries to find local database tools automatically, covering a range of installations without requiring specific configurations from the user. Tip * **For PostgreSQL on macOS** : Installing the `libpq` package may help DBeaver automatically detect the client. Use `brew install libpq` in your terminal. * **For MySQL Users on macOS** : To facilitate automatic client detection by DBeaver, consider adding the `mysql-client` package. This can be done using the command `brew install mysql-client` in the terminal. If you encounter any issues with automatic detection, or if you're on a Linux system, follow the subsequent manual configuration steps below. ### Find a database installation path¶ To find the installation path for the local client of a database in DBeaver, follow these general guidelines: * **For MySQL** : Use `mysqldump` as a keyword in your search command. This utility is often located in the `bin` directory of the MySQL installation. * **For PostgreSQL** : Substitute `mysqldump` with `pg_dump` when conducting your search. Like MySQL, this command should be in the `bin` directory of the PostgreSQL installation path. These instructions are applicable to the most commonly used databases, MySQL and PostgreSQL. 1. Open your terminal. 2. Use the `find` command to locate the MySQL installation: find / -name "mysqldump" 2>/dev/null 3. Upon successful execution, the terminal will output the path to your MySQL installation. For example: - `/usr/local/mysql-8.1.0-macos13-arm64/bin/mysqldump` 4. Copy this path for use in the next steps of the configuration process. ### Configure a local client in DBeaver on Mac and Linux¶ 1. Open DBeaver. 2. Right-click on the respective database and navigate to **Edit Connection Settings**. 3. Find the **Local Client** section and click on the **Browse** button that appears next to it. 4. Click the **Add Home** button to add a new client path. 5. For Mac users, press `Command+Shift+G` to open the prompt for path input. For Linux users, enter the path directly into the file selection dialog. 6. Input the MySQL path location found earlier and confirm. Make sure to input the path up to the database version folder, omitting `/bin/mysql`. For example, if the path found is `/usr/local/mysql-8.1.0-macos13-arm64/bin/mysqldump`, input `/usr/local/mysql-8.1.0-macos13-arm64/`. 1. After inputting the corrected path, click the **Open** button to select the path. 2. Click the **OK** button to finalize the local client configuration. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Lock-Manager/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * Lock Manager [ Lock Manager ](./) Table of contents * Supported databases * How to use * Managing locks * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported databases * How to use * Managing locks 1. [DBeaver](/docs/dbeaver) 2. Integrated tools # Lock Manager In DBeaver, you can use the Lock Manager to monitor and manage database locks. It helps identify blocking queries, and deadlocks, allowing you to resolve issues directly. ![](../images/ug/tools/lock_manager/lock-manager.png) ## Supported databases¶ * AlloyDB * Altibase * Exasol * [Db2](../Database-driver-IBM-Db2/) * [Greenplum](../Database-driver-Greenplum/) * [Oracle](../Oracle/) * [PostgreSQL](../Database-driver-PostgreSQL/) ## How to use¶ To see the processes causing the blocks and their queries: 1. In the [Database Navigator](../Database-Navigator/), expand your database connection. 2. Go to the **Administer** tab and select **Lock Manager**. 3. Review the list of active locks to identify blocking and waiting sessions. 4. Analyze the **Wait Statement** and **Hold Statement** columns to understand the conflicting queries. Tip Fields in the Lock Manager vary by database. Refer to your database's documentation for specifics. ## Managing locks¶ To manage locks and resolve conflicts, use the options available bottom toolbar of the **Lock Manager** : **Button** | **Name** | **Description** ---|---|--- ![](../images/ug/tools/lock_manager/kill-session-button.png) | **Kill waiting session** | Terminates the session or process waiting for a lock, resolving blocking issues by stopping it. ![](../images/ug/tools/session_manager/configure-auto-refresh-button.png) | **Configure auto-refresh** | Sets up automatic refresh intervals to keep lock data updated without manual input. ![](../images/ug/Refresh-projects-icon.png) | **Refresh locks** | Manually refreshes lock data to show the most recent information about active locks. Tip You can right-click on a specific lock in the list and use the context menu to perform the same actions. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Log-files/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * Error log [ Error log ](./) Table of contents * DBeaver log files * Standard log file paths * Customizing log files * Gathering log files for error reporting * Java fatal logs * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * DBeaver log files * Standard log file paths * Customizing log files * Gathering log files for error reporting * Java fatal logs 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Error log There is an Error Log view (main menu **Window - > Show View -> Error Log**) which contains all errors which occur during the DBeaver runtime. You can double click on the warning/error in the log viewer and see the error stacktrace. Please attach it to the bug report. Also, you can open the full log (all error messages) if you need: ![](../images/error-log-export.png) ## DBeaver log files¶ ### Standard log file paths¶ DBeaver writes different log files. Most of them are Eclipse logs. Log files usually reside in the `[your_workspace_location]/.metadata`. Tip For detailed guidance on locating your workspace, refer to the [workspace location](../Workspace-Location/) article. * On Windows, open Explorer and enter the path `%APPDATA%\DBeaverData\workspace6\.metadata`. * On Linux, execute `cd $XDG_DATA_HOME/DBeaverData/workspace6/.metadata`. * On MacOS, navigate to `~/Library/DBeaverData/workspace6/.metadata` in Finder. To view hidden folders, press ` Cmd+Shift+.`. Two standard log files: * `[your_workspace_location]/.metadata/.log` \- contains all warnings and errors occurring during normal operation. * `[your_workspace_location]/.metadata/dbeaver-debug.log` \- includes the same information as `.log` plus additional debug details. Note The `dbeaver-debug.log` file has a maximum size limit of 10 MB. If the file size exceeds this limit, a new log file is created. Additionally, a new file is generated each time DBeaver is started or restarted. In special cases, log files can be written in other directories. A special case is an emergency situation when DBeaver cannot start and there is no workspace. Two typical places to find emergency logs: * `/configuration` * `${HOME}/.eclipse/org.jkiss.dbeaver.product_` ### Customizing log files¶ You can customize the settings for your `dbeaver-debug.log` file. Follow these steps to configure the log file settings: 1. Navigate to **Window - > Preferences -> User Interface -> Error Logs**. 2. In the **Error Logs** settings, you have the following options to customize: Setting | Description ---|--- **Enable debug logs** | Toggles the recording of debug logs. **Log file location** | The directory where `dbeaver-debug.log` files are stored. **Max log file size (KB)** | The maximum size of the log file. **Max backup log files count** | The number of backup logs to keep. Note These settings take effect after DBeaver is restarted. ### Gathering log files for error reporting¶ When encountering an issue with DBeaver, providing log files is essential for diagnosis. To gather the logs: 1. Navigate to **Help - > Collect Diagnostic info**. 2. Select the folder to save the collected log information. Important Diagnostic info may contain sensitive information. You can disable sensitive data in the logs by following the guidelines in [our guide](../Admin- Preference-Restrictions/#configuration-file-parameters). Be cautious when sharing logs with third parties. ## Java fatal logs¶ On the rare occasion that the DBeaver process dies, it does not leave any valuable logs. This is caused by a Java VM crash. JVM creates a fatal log file for each crash (log gile `hs_err_PID.log`). This log usually resides in the same directory where the DBeaver launcher is (e.g. dbeaver.exe). But in some cases it is a write-protected directory and the log file will be created in other folder. Instructions on how to find the Java fatal log file: https://docs.oracle.com/javase/9/troubleshoot/fatal-error-log.htm Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Making-a-thread-dump/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * Making a thread dump [ Making a thread dump ](./) Table of contents * Finding jstack * For macOS and Linux * For Windows * Generating a thread dump on Windows * Generating a thread dump on Mac and Linux * Generating a thread dump without Java * For Linux users * For Windows users * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Finding jstack * For macOS and Linux * For Windows * Generating a thread dump on Windows * Generating a thread dump on Mac and Linux * Generating a thread dump without Java * For Linux users * For Windows users 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Troubleshooting # Making a thread dump Sometimes (due to some bug) DBeaver UI hangs, freezes, or works incorrectly. It is usually impossible to find the reason for such an issue without a thread dump. A thread dump is information about the internal execution state of the Java program. DBeaver incorporates the `jstack` tool for generating thread dumps. To use this pre-installed tool, it is essential to locate its directory in the DBeaver installation and execute it from there. Important The `jstack` tool is not included in the tar.gz without Java on the [DBeaver download page](https://dbeaver.io/download/), and in Downstream packages. DBeaver includes OpenJDK, which is an open-source version of Java. This means you do not need to purchase a separate Java license to use DBeaver. ## Finding jstack¶ The location of `jstack` varies depending on your operating system: ### For macOS and Linux¶ * Find the directory where DBeaver is installed. On macOS, proceed to the `Contents/Eclipse` subdirectory. Then, in both macOS and Linux systems, locate the `jre/bin/jstack` directory. This is the typical location for `jstack` in DBeaver installations. ### For Windows¶ * Find the directory where DBeaver is installed. * Within this directory, go to `jre/bin/jstack.exe`. This is the standard path to find `jstack` in DBeaver installations on Windows systems. Note If you did not install Java during the DBeaver installation (by unchecking the `Install Java` checkbox), `jstack.exe` will not be present. In this case, you need to install Java separately and locate `jstack.exe` within the Java installation directory. ## Generating a thread dump on Windows¶ To create a thread dump in DBeaver on Windows, follow these steps: 1. **Find DBeaver's Process ID** : 2. Open Task Manager by pressing `CTRL+SHIFT+ESC`. 3. In Windows 8 and later, switch to the "Details" tab. 4. Locate `DBeaver` (or `DBeaver[your version]`) in the process list and note its process ID (PID). Tip For example, if you are using the DBeaver Lite version, you should look for `DBeaverLite`. 5. **Open Command Prompt** : 6. Press `Win+R`, type `cmd`, and press `ENTER` to open the command prompt. 7. **Run the Thread Dump command** : 8. Navigate to the `jre/bin` directory within the DBeaver installation path. 9. Run the following command, replacing `PID` with the actual process ID of DBeaver: jstack.exe PID > "%HOMEPATH%\dbeaver-thread-dump.txt" 10. This command executes `jstack.exe`, generates a thread dump for the specified PID, and saves the output to `dbeaver-thread-dump.txt` in your home directory (e.g., `C:\Users\Username`). This file contains the thread dump information that can be attached to a GitHub issue for further analysis. ## Generating a thread dump on Mac and Linux¶ To create a thread dump in DBeaver on macOS and Linux systems, you can use the included `jstack` tool via the terminal. The following script will generate a thread dump and save it as `dbeaver-thread-dump.txt` in your home directory: /Applications/YOUR-VERSION-OF-DBEAVER.app/Contents/Eclipse/jre/Contents/Home/bin/jstack $(pgrep dbeaver) > ~/dbeaver-thread-dump.txt Tip Replace `YOUR-VERSION-OF-DBEAVER.app` with the version of DBeaver you have installed. For example, if you have DBeaver Lite version, the path would be `/Applications/DBeaverLite.app/Contents/Eclipse/jre/Contents/Home/bin/jstack`. ## Generating a thread dump without Java¶ ### For Linux users¶ If you are running DBeaver on Linux using the tar.gz version without Java included, you will need to install the Java Development Kit (JDK) to generate a thread dump. Follow these steps: 1. **Check for Existing JDK Installation** : 2. Open your terminal. 3. Type `which jstack` and press `Enter`. 4. If the JDK is installed, a version number will appear. 5. **Install JDK** : * If JDK is not installed, you need to install it. * Use your distribution's package manager to install JDK. For example, on Ubuntu, you can use `sudo apt install default-jdk`. After successfully installing JDK, proceed with the thread dump script: jstack $(pgrep dbeaver) > ~/dbeaver-thread-dump.txt After running this script, you will find the `dbeaver-thread-dump.txt` file in your home directory, containing the necessary thread information for diagnosing issues. ### For Windows users¶ If you are using DBeaver on Windows without Java, consider installing [Adoptium OpenJDK](https://adoptium.net/). Alternatively, you can reinstall DBeaver and ensure to check the `Install Java` checkbox during installation. After installing Java through either method, you can follow the instructions in the section Generating a Thread Dump on Windows to successfully generate a thread dump. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Managing-Charts/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * Managing charts [ Managing charts ](./) Table of contents * Creating Charts In SQL Editor * Creating Charts In Data Editor * Creating Charts In Grouping Panel * Editing Chart Settings * Setting Axis X * Setting Axis Y * Options * Copying to clipboard * Exporting Charts * Printing Charts * Zooming and Viewing Options * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Creating Charts In SQL Editor * Creating Charts In Data Editor * Creating Charts In Grouping Panel * Editing Chart Settings * Setting Axis X * Setting Axis Y * Options * Copying to clipboard * Exporting Charts * Printing Charts * Zooming and Viewing Options 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Managing charts Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. The default grid view of query results may look unremarkable. Use DBeaver's Charts feature to transform your `SELECT` queries into colorized charts. You can visualize data in **Bar** , **Line** , or **Pie** formats. Create a chart directly in the [SQL Editor](../SQL-Editor/), [Data Editor](../Data-Editor/) or [Grouping Panel](../Grouping-Panel/). It's a quick and simple way to bring your data to life. ## Creating Charts In SQL Editor¶ Visualizing large data sets makes your analysis faster and more precise. Charts let you grasp important details quickly. To create a chart in the **SQL Editor** , click the **Charts** button ![](../images/charts/charts_icon.png) on the left vertical toolbar of the query results area. Your data instantly transforms into a visual representation. ![](../images/charts/chart_SQLeditor_generated.png) ## Creating Charts In Data Editor¶ Charts are a powerful tool for visualizing structured analytical data, such as those stored in Views. If you want to create a chart for a table, it requires some preparation. First, sort and apply various [filters](../Data-Filters/) to the table's columns to structure the data. These changes directly affect the appearance of the chart, enabling you to customize the visual representation to fit your needs. To build a chart using the **Data Editor** , simply press the **Charts** button ![](../images/charts/charts_icon.png) located in the left vertical toolbar. A chart based on your structured data will be created. ![](../images/charts/chart_data_editor_generated.png) Note By default, the data for Y-axis is taken from the first column of the table containing numeric values. ## Creating Charts In Grouping Panel¶ The **Charts** feature also works with analytical tools like the **Grouping Panel**. When building a chart for a table that contains grouping results for one or more columns, you can easily switch the source data for the X and Y axes by changing the columns in the Charts Editor. To create a chart in the **Grouping Panel** , simply press the **Charts** button ![](../images/charts/charts_icon.png) on the left vertical toolbar ![](../images/charts/chart_grouping_panel_generated.png) ## Editing Chart Settings¶ To edit the chart settings, right-click inside the chart area to open the chart's context menu, and then select the **Settings** option. The **Chart Editor** will appear, allowing you to make adjustments. ![](../images/charts/charts_settings.png) The following chart settings can be adjusted: ### Setting Axis X¶ * choose a column for the X-axis from the **Column** dropdown Tip Make sure you choose unique columns for X-axis. * name the X-axis in the **Label** field * optionally, use **Order** to sort X-axis values in Ascending or Descending order Note If both X and Y sorting are enabled, the Y-axis sorting takes precedence over the X-axis sorting. ### Setting Axis Y¶ * choose a column for the Y-axis from the **Column** dropdown Note Only numeric and string columns can be used for Y-axis. * label the Y-axis in the **Label** field * for advanced customization, you can use the **Parse value with regex** option. Regular expressions (regex) allow you to filter, match, or manipulate the column values according to specific patterns or criteria. This functionality offers precise control over the data displayed on the Y-axis, enabling you to create more refined visual representations. If you're unfamiliar with regular expressions, the [Regular Expressions Tutorial](https://www.regular-expressions.info/tutorial.html) provides comprehensive guidance and examples. * optionally, use **Order** to sort Y-axis values in Ascending or Descending order Note If both X and Y sorting are enabled, the Y-axis sorting takes precedence over the X-axis sorting. ### Options¶ You can also set the following chart options: **Setting** | **Description** ---|--- **Sample count** | Maximum number of columns used to build the chart **Row count** | Maximum number of rows used to build the chart **Sample function** | Aggregate multiple rows into a single summary value displayed on the Y axis | `AVG` \- Average value | `SUM` \- Sum of all values | `FIRST` \- First value | `LAST` \- Last value | `COUNT` \- Total count of values | `MIN` \- Minimum value | `MAX` \- Maximum value **Chart type** | Choose how to visualize the data: **Bar** , **Line** , or **Pie** #### Copying to clipboard¶ You can copy a chart to a clipboard by selecting the **Copy to clipboard** option in the chart's context menu. #### Exporting Charts¶ You can export a chart into `PNG` format by selecting the **Save as...** option in the chart's context menu. #### Printing Charts¶ You can print a chart by selecting the **Print...** option in the chart's context menu. #### Zooming and Viewing Options¶ In the chart's context menu, you will find additional options for interacting with the chart: * **Zoom in** : Enlarge the view of the chart. * **Zoom out** : Reduce the view of the chart. * **Zoom Reset** : Return to the default zoom level. * **View as** : Change the visualization format of the chart. A submenu will appear, allowing you to select between **Bar** , **Line** , or **Pie** formats. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Managing-Data-Formats/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * Data format preferences [ Data format preferences ](./) Table of contents * Data Format Profiles * Changing Data Formats * Locale * Native Date and Time Mode * Data Type Format * Date * Time * Timestamp * Numbers * Restoring Default Data Formats * Datasource Settings * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Data Format Profiles * Changing Data Formats * Locale * Native Date and Time Mode * Data Type Format * Date * Time * Timestamp * Numbers * Restoring Default Data Formats * Datasource Settings 1. [DBeaver](/docs/dbeaver) 2. Data Editor # Data format preferences The DBeaver formatting functions allow you to set up database locale and change datasource format settings. This feature can be very useful, for example, for database migration. To change the data format settings use the option Window -> Preferences in main menu. ![](../images/ug/DataFormatting_Preferences.png) In the Preferences dialog box go to Editors -> Data Editor -> Data Formats. ![](../images/ug/Preferences_DataFormats.png) Or, in the [Database Navigator](../Database-Navigator/) right-click a connection and select **Edit Connection** menu option. ![](../images/ug/Database_Navigator_Edit_Connection_menu_option.png) In the right area of the opened **Data formatting preferences** dialog window go to Data editor -> Data Formats and select the **Datasource settings** check box in the left area to customize the data format settings. ![](../images/ug/DataFormatting_DatasourceSsettings.png) ## Data Format Profiles¶ Data format profiles allow you to apply a set of data format preferences to the whole current project by one click. To create a data format profile press the **Manage Profiles** button. In the opened dialog window press button **New Profile** , define the name and press **Create**. ![](../images/ug/DataFormatting_CreateNewProfile.png) To delete a data format profile press the **Manage Profiles** button, then in the opened dialog window select the profile you want to delete and press the button **Delete Profile**. ![](../images/ug/DataFormatting_DeleteProfile.png) ## Changing Data Formats¶ The following groups of data format settings can be adjusted: ### Locale¶ ![](../images/ug/DataFormatting_LocaleSettings.png) To define this setting select a language, country and variant if available. ### Native Date and Time Mode¶ ![](../images/ug/DataFormatting_NativeSettings.png) Select **Use native date/time format** check-box and the data format originally built-in to the datasource will be used. You can change the format of the following data types: ### Data Type Format¶ ![](../images/ug/DataFormatting_FormatSettings.png) The format of the following data types can be customized: * Date * Time * Timestamp * Numbers #### Date¶ The default value for this data type is _yyyy-MM-dd_. Pattern | Description ---|--- yyyy or y | Year of era (4 digits) yy | Year of era (2 last digits) YYYY | Week year M | Month in year without leading zeros MM | Month in year MMM | Short month name in year MMMM | Month name in year D | Day in year d | Day in month without leading zeros dd | Day in month E | Day name in week G | Era designator z | General time zone Z | RFC 822 time zone #### Time¶ The default value for this data type is _HH:mm:ss_ Pattern | Description ---|--- H | Hour in day (0-23) without leading zeros h | Hour in day in am/pm (1-12) without leading zeros HH | Hour in day (0-23) hh | Hour in day in am/pm (1-12) a | Am/pm marker m | Minute in hour without leading zeros mm | Minute in hour s | Second in minute without leading zeros ss | Second in minute S | Millisecond ffffff | Microseconds #### Timestamp¶ The default value for this data type is _yyyy-MM-dd HH:mm:ss_ [Link on Java date pattern documentation](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/SimpleDateFormat.html) #### Numbers¶ The following parameters can be configured from this type of data: * **Use Grouping** \- Long numbers can be hard to read if they have too many digits. For example, the factorial of 30 is 33 digits long! Select this check-box to enable Grouping mode, in which digits are displayed in clumps of 3 or 4 (depending on the current radix) separated by commas. * **Maximum integer digits** \- Defines the maximum number of digits to the left of the decimal point. * **Minimum integer digits** \- Defines the minimum number of digits to the left of the decimal point. * **Maximum fraction digits** \- Defines the maximum number of digits to the right of the decimal point. * **Minimum fraction digits** \- Defines the minimum number of digits to the right of the decimal point. * **Use data type scale for fraction digits** \- Some numeric columns or parameters may have a predefined scale, that is the maximum number of digits to the right of the decimal point. Select this check-box if you want the predefined precision to be used. * **Rounding mode** \- Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding mode indicates how the least significant returned digit of a rounded result is to be calculated. To learn more, please refer to [Oracle documentation](https://docs.oracle.com/javase/7/docs/api/java/math/RoundingMode.html). To change the data type format, change the value displayed in the **Pattern** area,save the changes made by pressing the **Apply** button and observe the expected result in the **Sample** field. ![](../images/ug/DataFormatting_PatternChange.png) ## Restoring Default Data Formats¶ To restore the default data format settings, press the **Restore Defaults** button. ![](../images/ug/DataFormatting_RestoreDefaults.png) ## Datasource Settings¶ Press **Datasource settings** link to change data format settings for a particular datasource, then adjust the settings in the opened dialog box. ![](../images/ug/DataFormatting_DatasourceSsettings_Workflow.png) To save changes made press **Apply**. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Managing-Master-Password/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * Master password [ Master password ](./) Table of contents * Security considerations * Encrypted data * Configure Master Password * Set up a password hint * Change the Master password * Recover the Master Password * Delete the Master Password * Administrator configuration of Master password policy * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Security considerations * Encrypted data * Configure Master Password * Set up a password hint * Change the Master password * Recover the Master Password * Delete the Master Password * Administrator configuration of Master password policy 1. [DBeaver](/docs/dbeaver) 2. [Security](/docs/dbeaver/Security-in-DBeaver-PRO) 3. Password secure storage # Master password Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. The Master password feature strengthens the security of DBeaver by encrypting credentials and sensitive data using a secure storage system. When you use the Master password feature: * **Isolated Security** : Connection details cannot be shared with other users because credentials are securely stored in an encrypted, user-specific location. * **Individual Protection** : Each set of credentials is safeguarded by the local user's own the Master password, ensuring personalized security. * **Project Specificity** : Connections with passwords can't be shared across users in projects because of the secure, user-specific storage. For more details, see [Project Security](../Project-security/) article. ## Security considerations¶ Secure storage is designed with security prioritization, which has certain trade-offs: * **Non-Portability** : The approach does not support the portability or sharing of configurations among a team of developers, which is mainly due to the OS-specific nature of password storage. * **User-Specific Encryption** : The Master Password secures data by locking it to your specific device. ## Encrypted data¶ DBeaver requires the Master password in these cases: * **Connecting to databases** : When you connect to a database with saved credentials. * **Editing connections** : If you open a connection's settings and it includes credentials. * **Using[Cloud Explorer](../Cloud-Explorer/) or [Cloud Storage](../Cloud-Storage/)**: The Master Password is necessary for any cloud setup. * **Using[Git](../Project-team-work/)**: To secure your Git credentials with encryption. * **Setting up[email profiles](../Data-transfer-email/) or editing email tasks**: When setting up or changing email settings for tasks (like notifications), if those credentials are encrypted. * **Using[Tableau](../Tableau-integration-in-DBeaver/)**: The Master Password is necessary for connecting or publishing data to Tableau. * **Using[AI features](../AI-Smart-Assistance/)**: To store and encrypt your AI access token. ## Configure Master Password¶ To set up the Master Password in DBeaver: * Go to **Window - > Preferences -> General -> Security** and click **Change password**. * (Alternatively) When you first attempt to save secure data \- DBeaver will prompt you to set up a Master Password. ![](../images/ug/Security-preferences.png) Once the **Master Password** provider is selected, you can manage secure storage with the following options: Button | Description ---|--- Change password | If a Master password has not been set, this option initiates the process of creating one. If a Master password is already in place, it allows for changing to a new master password. Recover password | Available after setting a Master password, this feature uses password hints and recovery questions to help recover a forgotten master password. Important DBeaver does not store the Master Password. If both the password and password hints are forgotten, the Master Password cannot be recovered or reset. ## Set up a password hint¶ When creating a Master password, it is recommended to set up a password hint. This hint will assist you if you need to recover your password. 1. When prompted, select **Yes** to provide a password hint after creating a Master password. ![](../images/ug/Password-hint-needed.png) 2. Enter a hint that will help you remember the password without revealing it directly. ![](../images/ug/Password-recovery.png) ## Change the Master password¶ To change the Master password, follow these steps: 1. In the **Security** tab, click on the **Change Password** button 2. Follow prompts to change the Master Password. Important When you change your Master password, the old one cannot be viewed or retrieved after recovery. Ensure you remember your new password or write it down in a secure place. ## Recover the Master Password¶ If you've forgotten your Master Password, you can attempt to recover it by following these steps: 1. In the **Security** settings, click **Recover password**. 2. Answer the security questions that were set up during the hint setup (if available). Note * The questions and answers are case-sensitive. * Treat the answers as secondary passwords; they should be kept confidential and secure. 3. After successfully answering the questions, you’ll see a confirmation message: _"The 'master' password has been successfully recovered and is cached in memory."_. Use this recovery process as a secure backup if you forget your Master Password. However, if you didn’t set up security questions initially, password recovery won’t be available. Once recovered, you can: * **Change the Master Password** by selecting **Change password**. * **Delete the Master Password** by selecting **Delete password**. ## Delete the Master Password¶ Warning Be aware that deleting the Master password will result in the loss of all saved credentials. 1. Go to **Window - > Preferences -> General -> Security**. 2. Click **Delete password**. 3. Confirm the action when prompted. 4. Restart DBeaver for the changes to take effect. ## Administrator configuration of Master password policy¶ Administrators can customize various aspects of the Master password policy. This includes setting the minimum length of the password, the minimum count of letters, digits, and symbols required, and the enforcement of mixed case (uppercase and lowercase letters) in the Master password. For detailed instructions on configuring these settings, please refer to the [Admin Preference Restrictions](../Admin-Preference-Restrictions/) article. Note Currently, this functionality is limited to Windows users and is only accessible through the Windows Registry. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Managing-Truststore-Settings/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * Manage certificates [ Manage certificates ](./) Table of contents * Certificates trust store * Java truststore * Keychain truststore * Windows truststores * Windows root truststore * Windows my user truststore * Custom truststore * Import certificates * Viewing and deleting certificates * Extended cloud certificates * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Certificates trust store * Java truststore * Keychain truststore * Windows truststores * Windows root truststore * Windows my user truststore * Custom truststore * Import certificates * Viewing and deleting certificates * Extended cloud certificates 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. [Connection network options](/docs/dbeaver/SSH-Configuration) 5. [SSL](/docs/dbeaver/SSL-Configuration) 6. Truststore management # Manage certificates Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. You can manage trust store settings in DBeaver to enable secured driver downloads and establish SSL connections. This is achieved by selecting one of the available trust stores and, if needed, adding or removing certificates from the **Custom Truststore**. Certificates are integral to establishing secure connections, allowing necessary driver files to be downloaded, and enabling SSL connections to databases. Without the appropriate certificates, you might encounter an error message. ## Certificates trust store¶ You can configure which trust store DBeaver uses to validate SSL certificates. ### Java truststore¶ The **Java Truststore** is available on all platforms and contains the default Java certificates. You can view certificates stored here, but you can’t modify them directly. The app uses a local copy derived from the Java store together with auto-imported certificates. ### Keychain truststore¶ On macOS, you can use the **Keychain Truststore**. This option relies on certificates stored in the system Keychain, and in the app it appears as a read-only view. The app builds a local copy for use, combining Keychain with default Java certificates and auto-imported certificates. Note You cannot add or remove certificates directly in DBeaver when using the Keychain Truststore. Certificate management must be done in the [macOS Keychain](https://support.apple.com/guide/keychain-access/welcome/mac) app. ### Windows truststores¶ On Windows, two trust stores are available. Both appear in the UI, are read- only in DBeaver, and are used via a local copy built by the app together with default Java certificates and auto-imported certificates. #### Windows root truststore¶ The **Windows Root** Truststore is machine-wide. Certificates added by an administrator at the OS level apply to all users on the machine. #### Windows my user truststore¶ The **Windows My** Truststore contains certificates for the current user. It includes the machine root certificates per Windows behavior. Note You cannot import any certificates into Windows trust stores from DBeaver. Manage them in Windows. ### Custom truststore¶ Use the **Custom Truststore** to import and manage certificates inside DBeaver. #### Import certificates¶ 1. Navigate to **Windows** -> **Preferences** -> **General** -> **Security** -> **Certificates Trust Store** and click the **Import** button. 2. Browse your file system, locate the certificate file (`.cer` or `.crt`), and select it. ![](../images/ug/truststore/Custom-truststore-certificate-import.png) 3. Assign an alias to the certificate and click **OK**. ![](../images/ug/truststore/Custom-truststore-preferences.png) 4. After applying changes to the trust store and clicking **Apply and Close** , DBeaver prompts a dialog suggesting a restart for the trust store changes to take effect. Once a certificate is added to the trust store, it enables secure connections and authentication. You can verify the validity of a certificate based on its expiration date. #### Viewing and deleting certificates¶ In the **Custom Truststore** section, select the certificate and click the **View** button to see details. To remove a certificate, select it and click the **Delete** button. ### Extended cloud certificates¶ Some cloud databases and services, like AWS, require additional certificate authorities (CAs) to work correctly. To trust these cloud provider certificates automatically, enable **Load extended cloud certificates** in Certificates Trust Store settings. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Managing-security-restrictions-for-database-connection/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * Security restrictions for database connection [ Security restrictions for database connection ](./) Table of contents * Security restrictions settings * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Security restrictions settings 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Security restrictions for database connection DBeaver allows the configuration of database connections with specific security settings. This can be done during the initial setup of a [new connection](../Create-Connection/#connection-details) or while [editing an existing one](../Edit-Connection/). ## Security restrictions settings¶ Within the **Security** section of the connection configuration, the following options are provided: ![](../images/connection-security-restrictions.png) 1. **Read-only connection** : This setting, when enabled, restricts the connection to read-only operations, ensuring no data can be modified or deleted. Tip Alternatively, you can use the [toolbar](../Application-Window- Overview/#toolbar) icon `Make [database name] read-only` (![](../images/make- database-read-only-icon.png)) to quickly toggle this mode. 2. By clicking on the **Edit permissions** , you can access additional security settings: Setting option | Description ---|--- **Restrict data edit** | Disables the ability to modify data within the database through this connection. **Restrict structure edit** | Prohibits alterations to the database structure, such as tables or indices. **Restrict script execute** | Prevents script execution, safeguarding against potentially harmful actions. **Restrict data import** | Blocks the import of data from external sources into the database. Tip For additional settings and restrictions, especially for administrative purposes, refer to documentation on [admin preference restrictions](../Admin- Preference-Restrictions/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Metadata-Panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * Metadata Panel [ Metadata Panel ](./) Table of contents * View metadata * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * View metadata 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # Metadata Panel The **Metadata** panel displays detailed information about the data structure of the current row in the [Data editor](../Data-Editor/). It helps you understand column properties and database-level details without leaving the data view. Info To open the **Metadata** click **Panels - > Metadata** on the [Right sidebar](../Data-Editor/#right-sidebar) or use [shortcut](../Shortcuts/#panels). ![](../images/ug/Metadata-panel.png) ## View metadata¶ The panel shows metadata for the row that contains the selected cell. For each column, you can see attributes such as: * column name and data type * type length, precision, and scale * nullable and default value settings * constraints (primary key, foreign key, unique, etc.) * source table and schema This panel is read-only and meant for quick inspection of database metadata. It’s especially useful when you work with unfamiliar tables or when you need to confirm column settings while editing data. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Mock-Data-Generation-in-DBeaver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * Mock data generation [ Mock data generation ](./) Table of contents * Key features * Generating mock data * Data generators * Boolean * Date * Numeric * String * Templates * Regex * Special data * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Key features * Generating mock data * Data generators * Boolean * Date * Numeric * String * Templates * Regex * Special data 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Mock data generation Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. The Mock Data generator in DBeaver automates the process of creating test data, making it much faster and more efficient than entering data manually. It is built to support the creation of large amounts of data, making it suitable for projects that require generating thousands of data entities. Important Mock Data is intended for generating test data in development environments and **should not be used in production**. Always ensure you have a [backup](../Backup-Restore/) of your database before initiating data generation. ## Key features¶ * **Support across RDBMS** : Compatible with all RDBMS supported by DBeaver including DB2, MS SQL Server, MySQL, Oracle, PostgreSQL, SQLite, and others. * **Schema compliance** : Automatically generates data that adheres to the database schema, supporting all base data types and constraints (PK, FK, unique, etc.). * **Extensive data generators** : Offers more than 20 data generators for various data types with customizable parameters. ## Generating mock data¶ 1. To start generating mock data, you can initiate the **Mock Data Wizard** using one of the following methods, depending on your current context: 1. **[Database Navigator](../Database-Navigator/)** : Right-click on a table, then select **Tools - > Generate Mock Data**. 2. **[Data Editor](../Data-Editor/)** : Access the context menu and choose **Generate Mock Data**. 3. **[Metadata Editor](../Database-Object-Editor/).**: Right-click on a table and select **Tools - > Generate Mock Data**. ![](../images/ug/mock-data/start-generating-mock-data.png) Tip It is possible to select multiple tables and generate mock data for all of them simultaneously. 2. After launching the **Mock Data Wizard** : 1. A configuration window appears where you can set the initial settings: Option | Description ---|--- **Remove old data** | Deletes any existing data before generating new data. **Row count** | Specify the number of rows to generate. **Batch size** | Define the size of batches for data generation. ![](../images/ug/mock-data/launching-the-Mock-Data-Wizard.png) 2. After configuring the initial settings, select a column in the table. Use the dropdown menu to choose the desired generator for each column according to your needs. Refer to the specific parameters section for detailed configuration options for each generator type. ![](../images/ug/mock-data/choose-the-desired-generator.png) 3. In the right column, configure the specific settings for the selected generator. These settings vary depending on the generator type. The following parameters are common across all types of data generators and can be configured to tailor the mock data: Parameter | Description ---|--- **% of NULLs** | Specifies the percentage of NULL values to generate for the column. **Random Seed** | Sets a seed for the data generation process to ensure reproducibility. Leave this field empty for a random seed. 3. Click the **Proceed** button to start the generation process. ## Data generators¶ Mock data generators provide configurable settings to tailor the generated data according to different requirements and data types. ### Boolean¶ Generator | Description ---|--- **Random** | Generates boolean values randomly. **Sequence** | Produces boolean values in a specified sequence. **Constant** | Generates boolean values based on specific constants. ### Date¶ Generator | Description ---|--- **Random** | Generates dates randomly within a specified range. **Sequence** | Produces dates in a sequence, with options for step and direction. **Constant** | Generates dates based on specific constants. ### Numeric¶ Generator | Description ---|--- **Random** | Generates random numbers within a range. **Sequence** | Produces numbers sequentially with specified steps and direction. **Constant** | Generates numbers based on specific constants. **Price** | Generates realistic price values within a specified range. **Coordinate** | Produces geographical coordinates. ### String¶ Generator | Description ---|--- **Text** | Generates strings based on a given template. **Random Text** | Generates random text. **UUID** | Generates unique identifiers. **Regex based** | Produces strings that match a specified regular expression pattern. **Email** | Generates email addresses with options for gender, surname inclusion, and a numeric suffix. **Name** | Produces personal names, configurable by gender and whether to include a surname. #### Templates¶ Directive | Description ---|--- **Address** | Generates US postal addresses. **City** | Generates names of major world cities. **Country** | Generates country names. **Domain** | Generates top internet domain names. **Email** | Generates email addresses based on gender and surname inclusion. **Name** | Generates personal names based on gender and surname settings. **Random** | Generates a random integer between specified limits. **Regex** | Generates values matching a specified regex pattern. **Sequence** | Generates a sequence of integers starting from a specific value with defined steps. ### Regex¶ Generator | Description ---|--- **Credit Card** | Generates strings that match common credit card number patterns. **Email** | Produces email addresses in a random format. **Gender** | Generates strings representing gender. **Hex Color** | Generates strings that represent hexadecimal color codes. **IP4** | Produces strings formatted as IPv4 addresses. **IP6** | Generates strings formatted as IPv6 addresses. **Phone Number** | Creates strings that resemble phone numbers in various formats. **Postal Code** | Generates strings that match postal code formats for different countries. **String Price** | Produces strings representing prices with currency symbols. ### Special data¶ Data Type | Description ---|--- **NULL** | Generates NULL values for database columns as specified. **FK (Foreign Key)** | Pulls data from referenced tables according to constraints. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/MongoDB/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * MongoDB [ MongoDB ](./) Table of contents * Setting Up * MongoDB connection settings * Connection details * MongoDB driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering MongoDB with DBeaver * MongoDB database objects * MongoDB features in DBeaver * Browsing MongoDB collections * Database operations * Executing JavaScript * Executing SQL * SELECT queries * Conditions * Nested fields * Working with object IDs * Working with JOINs * Aggregate functions * INSERT statement * UPDATE statement * DELETE statement * CREATE TABLE statement * DROP TABLE statement * Working with dates * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * MongoDB connection settings * Connection details * MongoDB driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering MongoDB with DBeaver * MongoDB database objects * MongoDB features in DBeaver * Browsing MongoDB collections * Database operations * Executing JavaScript * Executing SQL * SELECT queries * Conditions * Nested fields * Working with object IDs * Working with JOINs * Aggregate functions * INSERT statement * UPDATE statement * DELETE statement * CREATE TABLE statement * DROP TABLE statement * Working with dates 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. MongoDB # MongoDB Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use MongoDB with DBeaver. One of the standout features of DBeaver's MongoDB support is its flexibility in presentation. You can view MongoDB collections as standard relational tables, JSON documents, or even in chart presentations. DBeaver interacts with MongoDB servers using a specific driver, supporting versions from 2.x to the current version. DBeaver also supports MongoDB extension such as Cosmos DB, you can find more information about this driver in our [article](../Database-driver-CosmosDB/). Before you start, you must create a connection in DBeaver and select MongoDB. If you have not done this, please refer to our [Database Connection](../Create-Connection/) article. ![](../images/database/mongodb/mongodb-drivers.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies and SSL. ### MongoDB connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a MongoDB database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your MongoDB database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/mongodb/mongodb-connection-init.png) Field | Description ---|--- **Connect by (Host/URL)** | Choose whether you want to connect using a host or a URL. **URL** | If you are connecting via URL, enter the URL of your MongoDB database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your MongoDB database here. **Database** | Enter the name of the MongoDB database you want to connect to. **Replica Set** | Specify the name of the replica set if your MongoDB instance is a part of a replica set configuration. **Port** | Enter the port number for your MongoDB database. The default MongoDB port is `27017`. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- MongoDB Authentication \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with MongoDB database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### MongoDB driver properties¶ You can customize the MongoDB driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your MongoDB database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your MongoDB database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering MongoDB with DBeaver¶ DBeaver provides a host of features designed for MongoDB databases. This includes the ability to view and manage collections, along with numerous unique capabilities aimed at optimizing database operations. ### MongoDB database objects¶ DBeaver lets you view and manipulate a wide range of MongoDB database objects. DBeaver has extensive support for various MongoDB metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Collections * Java Script * Users * Administration * Active Operations ### MongoDB features in DBeaver¶ DBeaver is not confined to handling typical SQL tasks. It also embraces the NoSQL database spectrum, offering numerous unique features specifically designed for MongoDB. Beyond standard SQL operations, DBeaver facilitates a plethora of MongoDB-specific capabilities, such as: Category | Feature ---|--- Data Types | BSON Data Types (e.g., Object ID, ISODate) Security | User-Based Access Control Database Management | MongoDB Stored Procedures (JavaScript Functions) Additional features compatible with MongoDB, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) #### Browsing MongoDB collections¶ You can view or edit MongoDB collection content as standard relational tables (in grid/plain text presentations/chart) or as [JSON documents](../Working- with-XML-and-JSON/). You can switch between these presentations using the [toolbar](../Data-Editor/#left-sidebar) of the Data Editor. ![](../images/database/mongodb/mongodb-data-json.png) ### Database operations¶ #### Executing JavaScript¶ Execute JavaScript statements in the [SQL editor](../SQL-Editor/) as usual. DBeaver supports all JavaScript queries for MongoDB versions 2 and 3, as well as a subset of the `mongo` shell queries. Here is an example that creates a user in the current database: db.createUser({ user: 'testuser', pwd: 'test', roles: [] }) This example returns all documents in the collection 'test_col': db.test_col.find() Note Scripts will be executed in the current database. You can not set an explicit database name in your query. The current database can be changed on the SQL Editor toolbar or on the [Database Navigator](../Database-Navigator/). #### Executing SQL¶ You can use standard SQL statements (`SELECT`, `INSERT`, `UPDATE`, `DELETE`) to manipulate data in MongoDB. ##### SELECT queries¶ SELECT queries can include `WHERE`, `ORDER BY`, `GROUP BY`, `JOIN` and `HAVING` clauses. SELECT * FROM test_col WHERE propName.subProp='value' UPDATE FROM test_col SET propsName.val1=123 WHERE propName.subProp='value' Note The MongoDB dialect does not support SQL sub-queries. ###### Conditions¶ SELECT queries with `WHERE` clauses support `AND`, `OR`, `<`, `<=`, `>`, `>=`, `=` and `!=` operators: SELECT * FROM Employees WHERE (Country = 'CA' OR Country = 'RU') AND Age > 20; Tip Be aware that `AND` has a higher precedence than `OR` and will be evaluated first; enclose it with parentheses to maintain the correct order. ###### Nested fields¶ You can differentiate nested JSON fields using a dot. Enclose fields containing special characters (like spaces or dashes) with double quotes, as demonstrated below: SELECT title FROM movies WHERE info."imdb-details".rating > 6 ###### Working with object IDs¶ To find a document by ID, use the `ObjectId` function: SELECT * FROM documents WHERE _id = ObjectId('5f9c458018e3c69d0adc0fbd') ORDER BY value DESC ###### Working with JOINs¶ The SQL dialect for MongoDB supports `LEFT JOIN` and `INNER JOIN` currently: SELECT ar.Name as Artist, al.Title as Album, SUM(tr.Milliseconds) as Duration FROM Track tr INNER JOIN Album al ON tr.AlbumId = al.AlbumId INNER JOIN Artist ar ON al.ArtistId = ar.ArtistId GROUP BY Artist, Album ORDER BY Duration DESC Remember to specify aliases for both the source and target tables in a defined order, as shown: SELECT * FROM INNER JOIN ON .column = .column Executing the script below does not yield a merged document but produces separate documents for `Track` and `Album`: SELECT * FROM Track tr INNER JOIN Album al ON tr.AlbumId = al.AlbumId ###### Aggregate functions¶ In version 22.x only `COUNT` function is supported. ##### INSERT statement¶ You cannot use conditions in `INSERT` statements, only the basic form is supported: INSERT INTO (field1, field2) VALUES (val1, val2); ##### UPDATE statement¶ While you can use various expressions in the `WHERE` clause, sub-selects or joins are not permissible. UPDATE SET field2=val3 WHERE field1=val1; ##### DELETE statement¶ You may use any expression in the `WHERE` clause, but sub-selects or joins are not allowed. DELETE FROM WHERE field1=val1; ##### CREATE TABLE statement¶ In the `CREATE TABLE` statement, only the collection name can be specified, column lists are not allowed. CREATE TABLE ; ##### DROP TABLE statement¶ DROP TABLE ; ##### Working with dates¶ When working with dates, ensure to specify them in ISO format. This is applicable in both JavaScript and SQL dialects: db.dates.insert([ { value: new Date('2016-05-18T16:00:00Z') }, { value: new Date('2017-05-18T16:00:00Z') }, { value: new Date('2018-05-18T16:00:00Z') }, { value: new Date('2019-05-18T16:00:00Z') }, { value: new Date('2020-05-18T16:00:00Z') } ]) To query data in JavaScript, follow this example: db.dates.find({ value: { $gte: new Date('2018-05-18T16:00:00Z') } }) When querying data in the SQL dialect, you can use either the ISO format or UNIX timestamp (in milliseconds): SELECT value FROM dates WHERE value > ISODate('2018-05-18T16:00:00.000Z') ORDER BY value DESC SELECT value FROM dates WHERE value > ISODate(1526659200000) ORDER BY value DESC Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Navigation/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * Result set navigation [ Result set navigation ](./) Table of contents * Scrolling Results Page * Data Rows * History * Navigate Foreign Keys and Referencing Tables * Navigation Links * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Scrolling Results Page * Data Rows * History * Navigate Foreign Keys and Referencing Tables * Navigation Links 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Viewing and editing data # Result set navigation ## Scrolling Results Page¶ If the result set has many rows, you can scroll the results page. To learn how many rows the data table contains, click the **Calculate total row count** button in the bottom toolbar. The number of rows appears in a status field next to the button: ![](../images/ug/Calculate-rows-button.png). Alternatively, you can right-click a cell in the table and then click **Navigate - > Row Count** on the context menu. By default, DBeaver limits the number of rows fetched to **200** (you can change this value in the main toolbar or in preferences). The maximum number of rows that DBeaver fetches to display in the Data tab is specified in the Maximum result-set size field in the main toolbar: `![](../images/ug/Max- result-set.png) Once you scroll to the last row of the current result portion, DBeaver fetches the next portion (next N rows). You can disable this behavior in preferences. You can also manually fetch the next portion of data equal to the maximum result set size. To do so, click the **Fetch next page of results** button (![](../images/ug/Fetch-next-page-button.png)) in the bottom toolbar or right- click the table and click **Navigate - > Fetch next page** on the context menu. The number of rows fetched is visible in the status field under the data table: ![](../images/ug/Number-fetched-rows.png) To see the details, click the details button in the status field. To fetch the whole result set, click the **Fetch all rows** button (![](../images/ug/Fetch-all-rows-button.png)) in the bottom toolbar or right- click the table and click **Navigate - > Fetch All Data** on the context menu. Note Be careful when fetching the whole result set. If it is huge, it might cause program hangup or out-of-memory errors. You can navigate through the result set using standard shortcuts `Home`, `End`, `PgUp`, `PgDown`, `Ctrl+Home`, `Ctrl+End`. ## Data Rows¶ To jump to the first or last row or move one row forward or backward, use the navigation buttons in the bottom toolbar or on the context menu: ![](../images/ug/Navigation-buttons.png) ![](../images/ug/Navigate-date-thru-context-menu.png) To jump to a specific line, right-click anywhere in the table and click **Navigate** -> **Go to Line** on the context menu. Then in the Go to Row dialog box, enter the row number and click **OK**. ## History¶ DBeaver remembers the history of actions such as applying filters to data, opening reference tables and other tables via links. You can navigate among such tables and filtered views: * Use the forward and backward buttons in the top toolbar: ![](../images/ug/History-navigation.png) * Click `Ctrl+Left` or `Ctrl+Right` Hovering over these buttons displays the names of the tables or filtered views saved in the history. ## Navigate Foreign Keys and Referencing Tables¶ You can navigate with foreign keys or reference tables – those that reference the current table. To open a referencing table, press `Ctrl+1` or right-click the cell and click **Navigate- >Referencing tables->[table name]**: ![](../images/ug/Referencing-tables-menu.png) The referencing table opens in the same editor. To navigate back and forth between the initial and referencing tables, use the history navigation buttons (![](../images/ug/History-navigation.png)) in the top toolbar of the editor. In order to open a referencing table in a new window use the `Ctrl+Shift+1` shortcut to the show menu. ## Navigation Links¶ In the data editor, you can navigate to linked tables – the ones that the current table references. To open a linked table, click the Navigate link icon in a cell that contains it: ![](../images/ug/Navigate-link-icon.png) Another way is to right-click such a cell and click **Navigate - > Navigate link** on the context menu. The linked table opens in the same editor, filtered by the cell value: ![](../images/ug/Linked-table.png) Note The table name in green above the table indicates which table is currently open in the editor. To navigate back and forth between the initial and linked tables, use the history navigation buttons (![](../images/ug/History-navigation.png)) in the top toolbar of the editor. You can open a linked table in a separate editor. To do so, simultaneously hold the `Ctrl` key (or `⌘ command` key on macOS) and click the Navigate link icon (![](../images/ug/Navigate-link-icon2.png)) in the cell. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Network-configuration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * Network configuration [ Network configuration ](./) Table of contents * Options * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Options 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Network configuration # Network configuration To connect to remote databases securely, DBeaver supports several network options. You can create encrypted tunnels, route traffic through proxies, or integrate with infrastructure tools like Kubernetes and AWS SSM. ## Options¶ * **[SSH](../SSH-Configuration/)** * **[SSL](../SSL-Configuration/)** * **[Proxy](../Proxy-configuration/)** * **[Kubernetes](../Kubernetes-configuration/)** ![](../images/commercial.png) * **[AWS SSM](../AWS-SSM-Configuration/)** ![](../images/commercial.png) Tip Create [network profiles](../Network-profiles/) to save and reuse settings across connections. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Network-profiles/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * Network profiles [ Network profiles ](./) Table of contents * Create a profile * Use a profile * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create a profile * Use a profile 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Network configuration # Network profiles Use network profiles to save and reuse your network settings across multiple connections. They'll help you avoid repeating the same setup every time you create a new connection. Profiles are helpful when you * connect to many databases with the same network settings * switch between environments like staging and production * need to keep access settings consistent across different connections ## Create a profile¶ To create a new profile: 1. Start [creating a new connection](../Create-Connection/) 2. In the toolbar of the wizard, click **No profiles** button 3. In the dropdown, select **Edit profiles** ![](../images/ug/network/network-profiles.png) 4. In the profile editor: 1. In the left panel, click **Create** (![](../images/ug/network/ssh/Create-new-jump-host-button.png)) button 2. Enter a name for the new profile 3. Click **OK** to save the name 4. Configure the selected profile’s network options: * **[SSH](../SSH-Configuration/)** * **[SSL](../SSL-Configuration/)** * **[Proxy](../Proxy-configuration/)** * **[Kubernetes](../Kubernetes-configuration/)** * **[AWS SSM](../AWS-SSM-Configuration/)** ![](../images/ug/network/configure-the-selected-profile-network.png) 5. Click **Apply and close** ## Use a profile¶ To apply a profile: 1. Start [creating a new connection](../Create-Connection/) 2. In the toolbar, click **No profiles** 3. Select your saved profile from the dropdown ![](../images/ug/network/use-network-profiles.png) Info All included network settings will be automatically applied to the connection configuration. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/New-Table-Creation/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * New table creation [ New table creation ](./) Table of contents * Create table * Saving changes * Modify table * Delete table * Restrictions on table creation * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create table * Saving changes * Modify table * Delete table * Restrictions on table creation 1. [DBeaver](/docs/dbeaver) 2. [Tutorials](/docs/dbeaver/New-Table-Creation) 3. Table Creation # New table creation This guide provides detailed instructions on creating a new table in DBeaver. This is a beginner-friendly guide, meaning it is written for individuals who may not have previous experience with databases or DBeaver. A database table, the focal point of our guide, is a systematic arrangement of data. It consists of rows and columns, forming cells where the data resides. While the number of columns is fixed for a table, it can encompass an unlimited number of rows. The maximum number of columns a table can have in a database depends on the database management system. DBeaver facilitates various operations, including data manipulation and data definition, with these tables. Initially, the guide will cover the essential step of creating a table. After successfully creating a table, there are several enhancements you can add, such as columns, constraints, indexes, and triggers. The creation of a table is a fundamental operation in database management, and while there are many aspects to consider, not all of them are mandatory. The only mandatory step is the creation of the table itself and the definition of [columns](../Creating- columns/). The rest are optional and can be used to enhance the functionality and integrity of your database. While this guide is designed around PostgreSQL within DBeaver, the processes can vary slightly with other database systems. ## Create table¶ In DBeaver, creating a table is a straightforward process. Once you've [connected to your database](../Create-Connection/), you can initiate the table creation process by right-clicking on the Tables folder in the **[Database Navigator](../Database-Navigator/)** and selecting **Create New Table**. ![](../images/tutorial_images/1_CreateNewTable.png) Upon creating a new table in DBeaver, a window will open presenting the **[Properties editor](../Properties-Editor/)**. This is the dedicated interface where you can manage and manipulate your tables. The specific options available to you will depend on the capabilities of your chosen database system. ![](../images/tutorial_images/2_NewTable_NoData.png) There are also various ways to create a table: from the **Properties editor** and from the **Diagram**. * From **Properties editor** : In the **Database Navigator** , double-click on the database name or table name, or select **View schema** from the context menu. In the window that opens, navigate to the **Properties** tab, select the **Tables** section, right-click on the window, and choose **Create New Table**. * From **[Diagram](../ER-Diagrams/)** ![](../images/commercial.png) : In the **Database Navigator** , double-click on the database name or table name. In the window that opens, navigate to the **Diagram** tab, right-click on the window, and choose **Create New Table**. Alternatively, in the **Database Navigator** , right-click on the database/table name and click **View Diagram**. In the window that opens, you can right-click and choose **Create New Table**. ### Saving changes¶ Saving a table in DBeaver is a crucial yet straightforward process. Once you have defined the properties of the table, it's important to commit these changes to the database. Until you save your changes, your new table exists only within DBeaver and hasn't been created in the actual database. Here are the three options for saving the changes: * Click on **File** -> **Save** -> **Persist**. * Select the desired table in the **Database Navigator** and press `Ctrl+S` (or `CMD+S` for Mac OS), choose **Persist** to save the changes. * Utilize the **Save** button ![](../images/tutorial_images/10b_SaveButton.png) located at the bottom of the **Properties editor** and press **Persist** to save the changes. ![](../images/tutorial_images/10_Table_Save.png) ## Modify table¶ Modifying a table in DBeaver involves adjusting its structure or properties, such as adding, removing, or changing columns, adjusting constraints, or altering table settings. To make adjustments, navigate to the **Properties** editor. Access this by right-clicking the table's name in the **Database Navigator** menu and selecting **View Table**. ![](../images/tutorial_images/3_View_Table.png) The specific options and capabilities available to you when modifying a table will depend on the database system you're working with. Always refer to the documentation of your specific database system for detailed information. ## Delete table¶ Deleting a table in DBeaver involves a few simple steps. Firstly, navigate to the table you wish to delete in the **Database Navigator**. Once you've located the table, right-click on it and select the **Delete** option from the context menu. A confirmation dialog box will appear, allowing you to review the action before it's performed. ![](../images/tutorial_images/3a_Delete_Table.png) Upon confirming your decision, DBeaver will execute the necessary SQL command to remove the table from your PostgreSQL database. Please be aware that this action is permanent, and any data stored in the table will be irretrievably lost. Therefore, it's crucial to ensure that you've adequately backed up any important data before proceeding with the deletion. **Important** : The confirmation dialog box, which appears when you are deleting a table in DBeaver, offers an important feature called the **Cascade delete** option. This option, when selected, automatically removes all related records in child tables, aligning with the deletion of a record in the parent table. While this can be useful for maintaining data integrity, it should be used with caution. If not handled properly, it can lead to unintended data loss by deleting records that you may not have intended to remove. Always ensure you understand the relationships and dependencies in your data before using the **Cascade delete** option. ## Restrictions on table creation¶ DBeaver is a database management tool, and as such, it doesn't impose its own restrictions on table creation. Instead, the restrictions that apply when creating tables are determined by the specific database system you're using. However, there are some general considerations to keep in mind when creating tables: * **Naming Restrictions** : The name of the table must be unique within its schema. Most database systems also have restrictions on the length of the table name and the characters it can contain. * **Storage Restrictions** : The total amount of data that can be stored in a table is determined by the storage capacity of the database system. * **Performance Considerations** : While not a restriction per se, it's important to note that the structure of a table can have significant impacts on the performance of data retrieval and manipulation operations. For example, having a large number of columns, especially ones that are rarely used, can slow down query performance. Remember that the specific restrictions and limitations can vary depending on the database system you're using. Always refer to the documentation of the specific database system for detailed information. **Further Reading:** New Table Creation | [Creating columns](../Creating-columns/) | [Implementing constraints](../Implementing-Constraints/) | [Utilizing foreign keys](../Utilizing-Foreign-Keys/) | [Creating indexes](../Creating-Indexes/) | [Incorporating triggers](../Incorporating-Triggers/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/ODBC-JDBC-Driver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * ODBC & JDBC driver [ ODBC & JDBC driver ](./) Table of contents * Installing ODBC driver manager * Installing ODBC drivers * Configuring ODBC data sources * Creating ODBC connections in DBeaver * Making existing DBeaver connections use ODBC driver * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Installing ODBC driver manager * Installing ODBC drivers * Configuring ODBC data sources * Creating ODBC connections in DBeaver * Making existing DBeaver connections use ODBC driver 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Driver settings # ODBC & JDBC driver Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. ODBC allows you to create a connection to almost any database in DBeaver by using native ODBC drivers. You can use it as an alternative to DBeaver drivers, or if DBeaver does not have a driver for your database. As of now, we aim to support any ODBC drivers. However, the following database drivers have been verified for compatibility: * [Amazon Redshift](../Database-driver-Amazon-Redshift/) * [BigQuery](../Database-driver-BigQuery/) * [DB2 for LUW](../Database-driver-IBM-Db2/) * [DB2 for IBM i](../Database-driver-IBM-Db2/) * [MariaDB](../Database-driver-MariaDB/) * [MySQL](../Database-driver-MySQL/) * Microsoft Access * [Oracle](../Oracle/) * [PostgreSQL](../Database-driver-PostgreSQL/) * [SQL Server](../Database-driver-Microsoft-SQL-Server/) * [SQLite](../Database-driver-SQLite/) * [Snowflake](../Snowflake/) Important DBeaver does not and will not support 32-bit ODBC drivers due to the technical limitations of the 64-bit Java Virtual Machine (JVM). ## Installing ODBC driver manager¶ DBeaver works with ODBC drivers using ODBC driver manager. A driver manager is a component is installed in your operating system that provides access to drivers written in native programming languages. * On **Windows** , a driver manager is already installed by default. You can access it by pressing `WIN+R` and typing `odbcad32`. * On **Linux** and **macOS** , you need to install this component separately. We recommend the [iODBC driver manager](https://www.iodbc.org/) as it's confirmed to work flawlessly with DBeaver against Linux and macOS. To install, follow the provided instructions. You can access it by typing `iodbcadm-gtk` in the terminal. ## Installing ODBC drivers¶ * On **Windows** , it's done by installing a driver using Windows Installer (`.msi`). The installation is the same as for any other software. * On **Linux** and **macOS** , a driver can be either installed from a package manager or by building it manually. Once a driver is installed, you need to add it to the driver manager. Open the driver manager, go to **ODBC Drivers** tab, press **Add a driver** and select required files. ## Configuring ODBC data sources¶ **Note: The process is mostly the same for all operating systems.** 1. Open the driver manager 2. Go to **User DSN** or **System DSN** tab 1. Choose **User DSN** if you want to create a data source accessible only by the current user 2. Choose **System DSN** if you want to create a data source accessible by all users 3. Click **Add** and choose the appropriate driver 4. Configure data source settings and click **OK** ## Creating ODBC connections in DBeaver¶ Open the **New Database Connection** dialog and select **ODBC** (Not **ODBC - Legacy**). If you want to use a **configured ODBC data source** , switch to **Data Source** connection type and choose it from a drop-down menu: Data Source | Data Source (drop-down) ---|--- ![](../images/odbc/odbc-connection-datasource.png) | ![](../images/odbc/odbc-connection-datasource-dropdown.png) If you want to use an **ODBC driver directly** and manually configure connection parameters, switch to **Manual** connection type and choose an appropriate driver from a drop-down menu and fill the rest of the fields according to your configuration: Manual | Manual (drop-down) ---|--- ![](../images/odbc/odbc-connection-manual.png) | ![](../images/odbc/odbc-connection-manual-dropdown.png) ## Making existing DBeaver connections use ODBC driver¶ DBeaver allows you to replace the underlying database driver of a connection with our ODBC driver. This is not the same as creating a new ODBC connection as it keeps all database-specific functionality untouched. Note In this mode, you can't use database-specific authentication methods and settings. To do so, open existing connection and choose **ODBC** as the driver type from the drop-down menu: ![](../images/odbc/odbc-connection-substitution.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Oracle/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * Oracle [ Oracle ](./) Table of contents * Setting Up * Oracle connection settings * Connection details * Oracle driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Oracle with DBeaver * Oracle database objects * Oracle features in DBeaver * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting Up * Oracle connection settings * Connection details * Oracle driver properties * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Oracle with DBeaver * Oracle database objects * Oracle features in DBeaver 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Classic](/docs/dbeaver/Apache-Hive) 4. Oracle # Oracle This guide provides instructions for setting up and using Oracle with DBeaver. Before you start, you must create a connection in DBeaver and select Oracle. If you haven't done this, please refer to our [Database Connection](../Create- Connection/) article. DBeaver interacts with the Oracle server using a specific driver. It supports all versions of Oracle, but the correct driver must be selected: use 'Oracle (Legacy)' for versions `8.x`, `9.x`, `10.x` and 'Oracle' for version `11` and later. It also supports Oracle cloud database extensions such as Oracle Cloud JSON and Oracle NetSuite, both of which can be connected through [Cloud Explorer](../Cloud-Explorer/). ![](../images/database/oracle/oracle-driver.png) ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, and the driver setup for Oracle. ### Oracle connection settings¶ In this subsection, we'll outline the settings for establishing a direct connection to a Oracle database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Oracle database. 1. The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/oracle/oracle-connection-main.png) Field | Description ---|--- **Host** | If you're connecting via host, enter the host address of your Oracle database here. **Database** | Enter the name of the Oracle database you want to connect to. **Port** | Enter the port number for your Oracle database. The default Oracle port is `1521`. **Connection identifiers** | Choose whether you want to connect using a `Service name` or a `SID` identifier. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Oracle Database Native](../Authentication-Database-Native/) \- [OS Authentication](../Connecting-to-Oracle-databases/#os-authentication) ![](../images/commercial.png) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Oracle Kerberos Authentication](../Kerberos-Authentication/) ![](../images/commercial.png) \- [Oracle Wallet](../Connecting-to-Oracle-databases/#oracle-wallet- connection) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Role** | Choose whether you want to connect using a `Normal`, `SYSDABA` or a `SYSOPER` role. For more details, you can refer to the official [Administering User Accounts and Security](https://docs.oracle.com/cd/E11882_01/server.112/e10897/users_secure.htm#ADMQS007) article. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The **Oracle Properties** page of the connection settings offers additional options that allow you to customize your further connection to the Oracle database. ![](../images/database/oracle/oracle-properties-page.png) Field | Description ---|--- **Language** | Specify the Session Language. **Territory** | Specify the Session Territory. **NLS Date Format** | Specify NLS (National Language Support) Date Format. The default value of the `NLS_DATE_FORMAT` parameter is determined by the `TERRITORY` parameter. **NLS Timestamp Format** | Specify NLS Timestamp format. The default value of the `NLS_TIMESTAMP_FORMAT` parameter is determined by the `TERRITORY` parameter. **Length semantics** | specify the length semantics for `VARCHAR2` and `CHAR` table columns, user-defined object attributes, and PL/SQL variables in database objects created in the session. The length semantics can be specified as either `BYTE` or `CHAR`. **Currency symbol** | Specify the Currency symbol.You can find out which currency symbol your current session uses by querying the `V$NLS_PARAMETERS` view. **Show only connected user schema** | Show only a scheme of a connected user in the [Database Navigator](../Database-Navigator/). **Hide empty schemas** | Check existence of objects within schema and do not show empty schemas in tree. Enabled by default but it may cause performance problems on databases with very big number of objects. **Always show`DBA` objects** | Always shows DBA-related metadata objects in tree even if user do not has `DBA` role. **Always use`DBA_*` views** | Use `DBA_*` views instead of `ALL_*` views wherever it is possible **Use SYS schema prefix** | Use SYS schema prefix in all metadata queries. Otherwise use view names without explicit schema. **Simple constraint reading query** | Use simple metadata queries. May work slower but it is more stable for all Oracle versions. **Use UNION for table metadata reading** | Use legacy table metadata query. With `UNION` instead `JOIN`. It helps in some cases speed up reading of table data. **Search metadata in synonyms** | Search for metadata in synonyms so they’re available in [autocomplete](../SQL-Assist-and-Auto-Complete/), semantic validation, and [Outline](../SQL-Editor/#outline). May significantly slow down metadata search and autocompletion. **Search metadata in sequences** | Search for metadata in sequences so they’re available in [autocomplete](../SQL-Assist-and-Auto-Complete/), semantic validation, and [Outline](../SQL-Editor/#outline). May significantly slow down metadata search and autocompletion. **Use RULE hint for system catalog queries** | Adds `RULE` hint for some system catalog queries (like columns and constraints reading).It significantly increases performance on some Oracle databases (and decreases on others). **Show DATE values specifically as DATE** | Show `DATE` data type values specifically as `DATE`, not as a `TIMESTAMP`.This setting will not work with disabled date/time formatting. **Use metadata queries optimizer** | Use metadata queries optimizer. May significantly improve metadata reading performance on some systems. #### Connection details¶ The **Connection Details** section in DBeaver allows to customize your experience while working with Oracle database. This includes options for adjusting the **Navigator View** , setting up **Security** measures, applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Oracle driver properties¶ The settings for Oracle **Driver properties** enable you to adjust the performance of the Oracle driver. These adjustments can influence the efficiency, compatibility, and features of your Oracle database. For a complete walkthrough on setting up Oracle JDBC driver properties, you can refer to the official [Oracle JDBC documentation](https://docs.oracle.com/en/database/oracle/oracle- database/21/jajdb/oracle/jdbc/OracleConnection.html). These guide detail each driver's properties and how they can be used to optimize Oracle database connections. You can customize the Oracle driver in DBeaver via the **Edit Driver** page, accessible by clicking on the **Driver Settings** button on the first page of the driver settings. This page offers a range of settings that can influence your Oracle database connections. For a comprehensive guide on these settings, please refer to our [Driver manager](../Driver-Manager/) article. ### Secure Connection Configurations¶ DBeaver supports secure connections to your Oracle database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Oracle with DBeaver¶ DBeaver provides a host of features designed for Oracle databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### Oracle database objects¶ DBeaver lets you view and manipulate a wide range of Oracle database objects. DBeaver has extensive support for various Oracle metadata types, allowing you to interact with a wide variety of database objects, such as: * Schemas * Tables * Columns * Constraints * Foreign Keys * References * Triggers * Indexes * Partitions * Dependencies * Views * Materialized Views * Indexes * Sequences * Queues * Types * Packages * Procedures * Functions * Synonyms * Schema Triggers * Table Triggers * Database Links * Java * Jobs * Scheduler * Jobs * Programs * Recycle bin * Global metadata * Types * Public Synonyms * Public Database Links * User Recycle bin * Storage * Tablespaces * Files * Objects * Security * Users * Roles * Profiles * Administer * Session Manager * Locks Manager ### Oracle features in DBeaver¶ DBeaver isn't limited to typical SQL tasks. It also includes numerous unique features specifically for Oracle. Beyond regular SQL operations, DBeaver provides a range of Oracle-specific capabilities, such as: Category | Feature ---|--- Data Types | Oracle Nested Tables PL/SQL Support | PL/SQL Procedures | PL/SQL Functions Security | Oracle Permissions | Oracle Profiles | Oracle Roles | Changing Password ![](../images/commercial.png) User Management | Create/Clone Users ![](../images/commercial.png) Data Organization | [Oracle Partitions](../How-to-work-with-database-Partitions/#creating-partitions-in-oracle) Database Management | Oracle Dependencies Performance Tuning | Oracle Performance Reports | Oracle Execution Plans Script execution | [Execute scripts and commands with **SQL Plus** syntax](../SQL-Plus-Script-Execution/) Additional features compatible with Oracle, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Session Management | [Session Manager](../Session-Manager-Guide/) Backup and Restore | [How to Backup/Restore data](../Backup-Restore/) Schema Management | [Schema Compare ](../Schema-compare/) Data Visualization | [GIS Guide](../Working-with-Spatial-GIS-data/) | [ERD Guide](../ER-Diagrams/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/PGDebugger/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * Database debugger (PostgreSQL) [ Database debugger (PostgreSQL) ](./) Table of contents * Prerequisites for Debugging * Installation * PostgreSQL 12 on Ubuntu based distros * Installation from source code * Running debugger in the DBeaver interface * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Prerequisites for Debugging * Installation * PostgreSQL 12 on Ubuntu based distros * Installation from source code * Running debugger in the DBeaver interface 1. [DBeaver](/docs/dbeaver) 2. Integrated tools # Database debugger (PostgreSQL) ## Prerequisites for Debugging¶ To enable interactive debugging of PL/pgSQL procedures on a Postgres server, you need to use the _plugin_debugger_. The _plugin_debugger_ is a typical interactive debugger delivered as an extension. It requires a shared library preload in Postgres to operate the shared_preload_libraries parameter in the settings. The debugger is developed and maintained by EDB. Its source code is available for examination and improvement. The debugger provides the required server API for debugging PL/SQL procedures with: * Breakpoint management; * Step-by-step tracing; * Variable acquisition and management. ## Installation¶ ### PostgreSQL 12 on Ubuntu based distros¶ If you happen to have a PostgreSQL 12 installed via _apt_ , then the procedure is quite straightforward: sudo apt install postgresql-12-pldebugger sudo service postgresql restart After that, run the following command in the database or databases that you wish to debug functions in: `CREATE EXTENSION pldbgapi;` ### Installation from source code¶ You can find the source code in [this repository](https://github.com/EnterpriseDB/pldebugger). Installation instructions are located in the README file. ## Running debugger in the DBeaver interface¶ Open the source code of the function you want to debug. To toggle breakpoints, place the caret on the line you want the function to be stopped at and use a shortcut `Shift + Control + B`. Alternatively, you can toggle the breakpoint with your mouse by clicking on a ruler, as demonstrated in the screenshot below: ![](../images/debug/pldebugger-toggle-breakpoint.png) **NB.** You must only toggle the breakpoints when _Show header_ option is **not** on. Then you need to set up a debugging configuration. Locate the downward-facing arrow right to the bug icon, click on it, then _Debug As_ -> _Database Debug_ : ![](../images/debug/pldebugger-database-debug.png) The _Edit Configuration_ dialog opens. Set up input values in the table _Function parameters_. ![](../images/debug/pldebugger-edit-configuration.png) Click on _OK_ button, and you are ready to go! The usual buttons essential for debugging such as _Step Over_ and _Continue_ are located here: ![](../images/debug/pldebugger-handles.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Panels/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * Panels [ Panels ](./) Table of contents * Available panels * Open Panels * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Available panels * Open Panels 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # Panels Panels provide additional space in the [Data editor](../Data-Editor/) where you can explore and work with data in different ways. They open as tabs on the right side of the **Data** tab and are especially useful when working with complex types (structures, arrays), long text, or binary data. ![](../images/ug/Panels.png) ## Available panels¶ Each panel focuses on a specific task: Panel | Description ---|--- [**Value viewer**](../Value-Panel/) | View and edit cell values, including complex types, text, and binary content. [**Metadata**](../Metadata-Panel/) | Display metadata for the current row and its columns. [**Calc**](../Calc-Panel/) | Calculate basic statistics like `COUNT`, `SUM`, or `AVG` for selected data. [**Grouping**](../Grouping-Panel/) | Group and aggregate data using SQL-like `GROUP BY` functions. [**References**](../References-Panel/) | View related records from other tables linked by foreign keys. [**Result details**](../Result-Details-Panel/) | Show query execution details such as job ID, bytes processed, and cache usage.This panel is specific to [BigQuery](../Database-driver-BigQuery/). [**Query trace**](../Query-Trace-Panel/) ![](../images/commercial.png) | Trace query execution steps across database nodes. This panel is specific to [Cassandra](../Cassandra/) and Yugabyte CQL. ## Open Panels¶ To open a Panels, click **Panels** (![](../images/ug/panels-button.png)) on the bottom toolbar or use [shortcut](../Shortcuts/#panels). Info By default, the [Value viewer](../Value-Panel/) opens, but you can switch to any other panel from the dropdown menu next to **Panels**. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Pending-Transactions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * Pending transactions [ Pending transactions ](./) Table of contents * Pending transactions * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Pending transactions 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Transaction mode # Pending transactions ## Pending transactions¶ It might be useful to check your pending transactions because they might lock your database. To see your pending transactions, click the arrow next to the **Transaction Log** button in the toolbar and then click **Pending Transactions** on the dropdown menu: ![](../images/ug/Pending-transactions-open.png) The upper table of the Pending transactions window shows currently active connections and the number of their transactions. The bottom table shows query details of the connection that is currently in focus in the upper table: ![](../images/ug/Pending-transactions-window.png) When the Pending transactions window opens, the upper table shows only those connections that have pending transactions. If no connections have pending transactions, the table is empty. To see all connections that are currently active (connected), select the **Show all connections** checkbox. You can commit or roll back transactions right from the Pending transactions window: in the upper table, click the row with the required uncommitted transactions and then click the **Commit** or **Rollback** button, depending on your purpose. If a transaction is committed/rolled back successfully, both buttons are disabled. If the operation is unsuccessful, the system displays an error message. To see all previous transactions made during the current session, select the **Show previous transactions** checkbox. To see all queries including non- transactional ones, select the **Show all queries** checkbox. The green rows are committed transactions, the orange (or red) ones are rolled back, rows without a special color are non-transactional or pending transactions. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/PostgreSQL-Arrays/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * PostgreSQL Arrays [ PostgreSQL Arrays ](./) Table of contents * Creating Array column * Creating Array Data * Modifying and Querying Array Data * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Creating Array column * Creating Array Data * Modifying and Querying Array Data 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # PostgreSQL Arrays DBeaver offers support for array data types in managing [PostgreSQL](../Database-driver-PostgreSQL/) databases. This feature enables the storage of multiple values in a single variable, allowing for more efficient and organized data management. A complete list of types is available in the **Edit Attribute** window in the data type selection dropdown when [creating a column](../Creating-columns/#create). The representation of these array data types in DBeaver requires a specific notation. An underscore `_` is placed before the data type, distinguishing array data types from scalar ones. ## Creating Array column¶ You have the flexibility to create an array column either via the [**Properties Editor**](../Properties-Editor/) or the [**SQL Editor**](../SQL- Editor/) in DBeaver. In the **Properties Editor** , navigate to the **Edit Attribute** window. Choose your desired array data type, For an array of integers, such as `_int4`, from the data type selection dropdown. ![](../images/database/postgresql/postgre-array-creation.png) Alternatively, you can execute a script in the **SQL Editor** to add an array column to an existing table. For example, the following command will add a new integer array column called 'ratings' to your table: ALTER TABLE film ADD ratings _int4 NULL; ## Creating Array Data¶ Once the table is created, you can use the SQL script in the **SQL Editor** to insert data into the array column. For example, this script utilizes the array constructor with nested arrays: INSERT INTO film (film_title, ratings) VALUES ('Inception', array[array[8, 9], array[7, 9], array[8, 10]]); This script, "Inception" has received three sets of ratings. Each set could represent ratings from a different platform or group of users, for example. Each set contains two ratings, in this case. ## Modifying and Querying Array Data¶ Once you've established an array column, DBeaver allows you to modify and query the array data just like you would perform any other operations in PostgreSQL. You can use standard SQL commands like `UPDATE`, `INSERT`, and `SELECT` to manipulate and retrieve data from your array columns. The array data is treated the same way as any other data type in PostgreSQL, granting you all the flexibility of SQL operations. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/PostgreSQL-Extensions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * PostgreSQL Extensions [ PostgreSQL Extensions ](./) Table of contents * Install Extensions * Database Navigator * SQL Editor * Using Extensions * Deleting Extensions * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Install Extensions * Database Navigator * SQL Editor * Using Extensions * Deleting Extensions 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # PostgreSQL Extensions DBeaver offers support for [PostgreSQL](../Database-driver-PostgreSQL/) extensions. These tools allow you to customize and extend your database's functionality beyond its default capabilities. From adding new data types and functions to enhancing performance and database operations, PostgreSQL extensions offer a range of possibilities. The ability to install, use, and delete PostgreSQL extensions within DBeaver provides a seamless and integrated experience, making it simpler for you to leverage the full potential of your PostgreSQL database system. ## Install Extensions¶ With DBeaver, you have two ways to install PostgreSQL Extensions - through the [Database Navigator](../Database-Navigator/) and using the [SQL Editor](../SQL-Editor/). Note Be sure to have the appropriate permissions to perform the installation. The ability to add extensions typically requires database administrative privileges. Without these, you may encounter errors during the installation process. ### Database Navigator¶ Navigate to the **Database Navigator** -> **Databases** -> **Extensions**. Right-click on the **Extensions** and select **Create New Extension**. In the opened dialog box, you can select the **Schema** , required **Extension** from the list and confirm the installation. ![](../images/database/postgresql/postgre-extensions-installation.png) ### SQL Editor¶ Alternatively, you can install an extension directly using a SQL command. Open the SQL Editor, and type the appropriate SQL command to create the extension. For example, to install the "uuid-ossp" extension, you would run: CREATE EXTENSION IF NOT EXISTS "uuid-ossp"; Then, [execute](../SQL-Execution/) the command. DBeaver will run this command on your PostgreSQL server to install the extension. ## Using Extensions¶ After installing the extension, its functionality becomes available. New functions, data types, operators, or other features may be available in your SQL queries depending on the extension. For example, if you have the `uuid-ossp` extension installed, you can use the `uuid_generate_v4()` function to generate universally unique identifiers (UUID). It can be used directly in SQL queries or as a default value when creating a new table. ## Deleting Extensions¶ Deleting an extension in DBeaver is as simple as installing one. Navigate to the **Extensions** in the **Database Navigator** , right-click on the extension you wish to remove, and select **Delete**. Confirm the deletion in the dialog box that appears. **Important** : Dropping an extension will remove all functionalities and data types associated with it. Ensure you have a clear understanding of the impact on your database before performing this operation. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Posting-issues/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * Posting issues [ Posting issues ](./) Table of contents * Posting issues * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Posting issues 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Troubleshooting # Posting issues ## Posting issues¶ * Check existing issues for your issue (including closed ones). Duplicating an issue is slower for both parties so search through the open and closed issues to see if what you are running into has already been addressed. * Be clear about what your problem is: what was the expected outcome, what happened instead? Detail how someone else can recreate the problem. * If you posting a bug report check "Error Log" view. If there are any errors related to your bug then post a complete stacktrace. Sometimes there are no errors in Error Log - if so, try to find them in [log files](../Log-files/). * If your issue is related to database data or metadata management - check the Query Manager view. It contains information about all queries DBeaver executes (explicitly or implicitly). To see more detailed information you can configure Query Manager in Preferences. ![](../images/qm-view.png) * Depending on the nature of your bug report provide information about: * Operating system * Window manager (for Linux) * Database (name and version) * Database driver (name and version) * Do not write issue type in the issue title (like Feature Request:, Bug: etc). We will review your issue and assign a corresponding label. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Pre-configured-Variables/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * Pre-configured variables [ Pre-configured variables ](./) Table of contents * Variables * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Variables 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Pre-configured variables DBeaver includes pre-configured variables that facilitate automatic insertion. These variables allow for customization by integrating predefined environment or user-specific information. Variables such as `${host}` and `${port}` are used to dynamically adjust connection details, whereas `${date}` and `${time}` can be directly employed in SQL scripts for operations such as logging. Tip You can create your own custom variables in the [Variables panel](../Variables-panel/) to suit your specific needs. ## Variables¶ In the table below, you will find pre-configured variables used in DBeaver for automating and customizing database operations. Variable | Description | Example value ---|---|--- `${host}` | Target database host. | `localhost` `${host.tunnel}` | Tunnel host name. | `localhost` `${port}` | Target database port. | `5432` `${database}` | Target database name. | `postgres` `${user}` | Database user name. | `postgres` `${url}` | Connection URL. | `jdbc:postgresql://localhost:5432/postgres` `${connection.type}` | Connection type. | `dev` `${datasource}` | Datasource. | `postgres` `${project.path}` | Project path. | `/Users/user/Library/DBeaverData/workspace6/General` `${project.name}` | Project name. | `General` `${workspace}` | Workspace path. | `/Users/user/Library/DBeaverData/workspace6` `${home}` | OS user home path. | `/Users/user` `${dbeaver_home}` | Application install path. | `/Applications/DBeaverUltimate.app/Contents/Eclipse` `${application.path}` | Application install path. | `/Applications/DBeaverUltimate.app/Contents/Eclipse` `${application.name}` | Application name. | `DBeaver Ultimate` `${application.version}` | Application version. | `24.1.0.202406080852` `${local.ip}` | Local IP address. | `192.168.31.154` `${date}` | Current date. | `20240614` `${time}` | Current time. | `15:30:00` `{server}` | The name of the target server. | `server1` `{folder}` | The path to a folder on the local file system. | `/path/to/local/dbfolder` `{file}` | The path to a file on the local file system. | `/path/to/local/databasefile.jar` Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Project-Explorer/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * Project explorer [ Project explorer ](./) Table of contents * Project explorer * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Project explorer 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Projects # Project explorer ## Project explorer¶ The **Project Explorer** view displays detailed contents of the currently active project. To open the **Project Explorer** , click **Window** -> **Project Explorer**. ![](../images/ug/Project_Explorer-view.png) For information on how to change the view layout, please see the [Application Window Overview](../Application-Window-Overview/) article. The title of the **Project Explorer** includes the name of the project: Project – [Project name]. **General** is a project that initially exists in the system by default. The **Project Explorer** displays the content of a project with metadata. The content includes: [**Bookmarks**](../Bookmarks/), [**Diagrams**](../ER- Diagrams/), and [**Scripts**](../Script-Management/). The metadata appears in columns which you can hide or show. The **Project Explorer** view provides a toolbar that contains the following buttons: Button | Name | Description ---|---|--- ![](../images/ug/Configure-columns-visibility-icon.png) | **Configure columns visibility** | Opens a dialog box in which you can select columns to display in the view ![](../images/ug/Collapse-All-icon.png) | **Collapse All** | Collapses the tree to the root level ![](../images/ug/Expand-All-icon.png) | **Expand All** | Expands the tree nodes ![](../images/ug/Link-with-Editor-icon.png) | **Link with editor** | \- Enabled when at least one editor is open, otherwise disabled \- Highlights the object in the tree that has its editor open To sort the metadata in the table by a certain column, click the column header. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Project-security/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * Project security [ Project security ](./) Table of contents * Project password management * Setting a Project password * Disabling a Project password * Resetting a forgotten Project password * Master password * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Project password management * Setting a Project password * Disabling a Project password * Resetting a forgotten Project password * Master password 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Projects # Project security Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. DBeaver provides strong security features to help you manage and protect sensitive connection data within your projects. This includes safely storing credentials and settings for: * [Database](../Authentication-Database-Native/) server user credentials. * [SSH tunnel](../SSH-Configuration/) user credentials. * [Proxy](../Proxy-configuration/) user credentials. * [AWS SSM](../AWS-SSM-Configuration/) parameters. By default, user names and passwords are stored in the `credentials- config.json` file, encrypted with a DES key. However, this key is not secure as it is publicly available in DBeaver source files, making it possible for unauthorized third parties to decrypt the file using external software. Tip For more secure options, you can read the [Security in DBeaver PRO](../Security-in-DBeaver-PRO/) article. ## Project password management¶ You can secure your DBeaver project by setting a Project password, which encrypts the project's configuration. ### Setting a Project password¶ To enable a Project password: 1. Open the project properties: * Navigate to **File - > Project Security** in the main menu. * Click the **Configure** icon ![](../images/ug/Configure-button.png) in the [Project Explorer](../Project-Explorer/) toolbar, then switch to the **Project Security** tab. * Press `ALT+Enter` for Windows/`⌘+I` for macOS on your Project folder in the **Projects** view and switch to the **Project Security** tab. 2. In the Project Security page, click the **Set password** button to initiate password setting. You will be prompted to enter and confirm the password. ![Set Project Password](../images/ug/project-security-preferences.png) 3. After setting the password, be sure to click on **Apply** or **Apply and Close** to save the changes. ### Disabling a Project password¶ To disable your Project password: 1. Access the project properties as outlined in the setting section. 2. Click the **Clear password** button. 3. Click on **Apply** or **Apply and Close** to save the changes. 4. In the confirmation dialog that appears, click **Yes** to finalize the removal of the project password. ### Resetting a forgotten Project password¶ If you forget your Project password, you can reset it during the login process. ![Reset Project Password](../images/ug/reset-project-password.png) Important Resetting your password when forgotten will delete all stored database credentials, requiring reconfiguration. ## Master password¶ It is possible to set a Master password for all Projects in a local workspace. The Master password provides an additional layer of security by storing credentials in a secure local storage. The side effect of using a Master password is that it affects the ability to share projects with complete credentials. If a Master password is enabled, credentials are stored locally and are not included when you export the project. Info This means that while you can export a project with all settings, the credentials for connections will not be included if a Master password is active. In contrast, if no Master password is set, exported projects will include the connection credentials. ![](../images/ug/Security-preferences.png) For more information about the Master password, refer to the [Managing Master Password](../Managing-Master-Password/) article. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Project-team-work/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * GIT integration [ GIT integration ](./) Table of contents * Create and share a Project repository * Cloning Existing Repositories * Updating remote repository with changes * Pulling new changes from remote branch * Installing the Git extension * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create and share a Project repository * Cloning Existing Repositories * Updating remote repository with changes * Pulling new changes from remote branch * Installing the Git extension 1. [DBeaver](/docs/dbeaver) 2. Integrated tools # GIT integration Note This feature is available in [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. For Git functionality specific to the Team Edition, please refer to [Team Edition Git documentation](https://dbeaver.com/docs/team-edition/Version-control/). For users of the Community edition to access **Git** feature, first install the required extension. DBeaver supports full integration with Git, a version control system. This integration allows users to maintain project configurations, scripts, diagrams, bookmarks, and other artifacts in a Git repository. It facilitates project management by enabling version control and collaboration within DBeaver. In this guide, we will cover the foundational Git operations in DBeaver, such as creating and cloning repositories, committing changes, and pulling updates. DBeaver's Git support is built on the Eclipse platform. For advanced Git functionalities like branching, and merging conflicts, refer to the [Eclipse EGit documentation](https://github.com/eclipse-egit/egit/wiki/User-Guide). ## Create and share a Project repository¶ To share an existing project, follow these steps: 1. Navigate to the **Projects tab** , select the project you want to share, and choose **Team - > Share project** from the context menu. ![](../images/ug/git/share-project.png) 2. Create a new local repository. 3. On the repository page on GitHub copy the repository URL/SSH. Tip For more details on creating GitHub repository you can refer to the official [GitHub documentation](https://docs.github.com/en/repositories/creating-and- managing-repositories/creating-a-new-repository). 4. Generate a GitHub **access token** in **Settings - > Developer Settings -> Personal access tokens -> Tokens (classic) -> Generate new token (classic)**. Select all options in the `‘repo’` section and `‘read:org’` under `admin:org`. Important DBeaver supports all types of Git tokens, including fine-grained and Personal access tokens (classic). 5. In DBeaver, right-click the project node and choose **Team - > Commit…** or use the shortcut `Ctrl+#`. Stage the files you wish to include in the commit by clicking **Add**. Enter a clear and concise commit message, then click **Commit** to finalize your changes. ![](../images/ug/git/commit-changes.png) 6. Use the **Push HEAD** button and paste the GitHub repository URL/SSH and provide your GitHub **User** and **access token** as the **Password**. ![](../images/ug/git/push-master.png) 7. Push changes to the remote repository by using the **Push** button. ## Cloning Existing Repositories¶ To clone an existing repository, ensure you have a GitHub account and follow these steps: 1. Click on **Create Project from Git** ![](../images/ug/git/create-project-from-git-button.png) at the **Projects** Tab or navigate through **File - > Git -> Create Project from Git** in the [Main menu](../Application-Window-Overview/#menu-bar). 2. Obtain the remote repository's URL from its GitHub page by clicking the **Code** button and copying the URL/SSH. 3. Generate a GitHub **access token** in **Settings - > Developer Settings -> Personal access tokens -> Tokens (classic) -> Generate new token (classic)**. Select all options in the `‘repo’` section and `‘read:org’` under `admin:org`. 4. In the wizard, enter the remote repository location. Use your GitHub **User** (it is commonly `git`) and **access token** instead of a **Password**. 5. Choose which branches to clone from the remote repository. 6. Define the local file system location for the repository storage and set initial configurations. 7. Select the desired wizard type for the project setup and complete the cloning process. The project will now be visible in the [Project Explorer](../Project-Explorer/). ## Updating remote repository with changes¶ After making changes to your project, such as creating, deleting, or modifying connections, scripts, or ERDs, follow these steps to update your remote repository: 1. Right-click on the project in the **Projects** tab and select **Team - > Commit** to open the commit interface. ![](../images/ug/git/commit-changes.png) 2. In the **Git Staging** tab at the bottom, you will see **Unstaged Changes**. Use the **Add Selected files to the index** ![](../images/ug/git/add-selected-files-to-the-index-button.png) or **Add all files to the index** ![](../images/ug/git/add-all-files-to-the-index-button.png) button to stage the changes you want to commit. Enter a commit message and then execute the commit using the **Commit** button or `Ctrl+Enter`. The commit will then be visible in the **History** tab (**Window - > Show view -> Other -> Version Control(Team) -> History**). 3. To push your commit to the remote repository, you can use the **Commit and Push** button. Alternatively, to push changes manually, navigate through the project's context menu (**Team - > Remote -> Push**) or from the **History** tab by right-clicking on the desired commit and selecting **Push commit**. This updates your git repository with the new changes. ## Pulling new changes from remote branch¶ To incorporate new changes from the remote branch into your local project, follow these steps: 1. Right-click on the project in the **Project** tab and select **Team - > Pull**. Alternatively, if you are in the Git Repositories view, you can right-click on the repository and select **Pull**. This action fetches and merges any new changes from the branch your local repository is tracking into your current branch. 2. If you have not made any local changes, or if you wish to discard your local changes and synchronize with the remote branch, you can use the **Team - > Reset** command. This will reset your local repository to the state of the remote repository, discarding any local changes that have not been committed. This process ensures your project is up to date with the latest changes from the remote branch, facilitating collaboration and avoiding potential merge conflicts. ## Installing the Git extension¶ Community Edition users can manually install the Git extension by following these steps: 1. **Via Eclipse Marketplace:** * Visit the Eclipse Marketplace [URL](https://marketplace.eclipse.org/content/dbeaver-git-support) * Follow the instructions to install the Git support extension directly through your DBeaver installation. 2. **Via P2 Repository:** * Open DBeaver, and navigate to **Help - > Install New Software**. * Enter the P2 repository [URL](https://dbeaver.io/update/git/latest/) in the **Work with** field. * Select the Git extension from the list of available software and follow the on-screen instructions to complete the installation. After installation, restart DBeaver for the changes to take effect, and you will have access to Git functionality within your DBeaver environment. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Projects-View/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * Projects view [ Projects view ](./) Table of contents * Project Structure * Toolbar and View Menu * View Menu items * Context Menu * Special Actions * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Project Structure * Toolbar and View Menu * View Menu items * Context Menu * Special Actions 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Projects # Projects view You might need to classify and group database connections into projects. Projects store objects related not to a particular database but to all database connections. These are usually files stored on the file system. The Projects view displays all projects created in the system and provides tools to manage them. To open the Projects view, on the **Window** menu, click **Projects**. ![](../images/ug/Projects-view.png) For information on how to change the view layout, please see the [Application Window Overview](../Application-Window-Overview/) article. ## Project Structure¶ Projects in the system are displayed in a tree format and all have the same high-level structure: Section | Description ---|--- **Connections** | Repeat the content of the Database Navigator view for this project. Perform the same actions over the objects of the databases as in the Database Navigator. **Bookmarks** | Contains [bookmarks](../Bookmarks/) – shortcuts to database objects. **Diagrams** | Contains [Diagrams](../ER-Diagrams/) that you can drag-and-drop here from other folders. **Scripts** | Contains [scripts](../SQL-Editor/) that you can drag-and-drop here from other folders. ## Toolbar and View Menu¶ The toolbar is integrated into the title bar at the top of the window and contains buttons that mirror items in the view menu. ### View Menu items¶ To open the view menu, click the **View Menu** button ![View Menu Icon](../images/ug/View-menu-icon.png) located in the upper-right corner of the window. The view menu contains the following items: Icon | Item | Description ---|---|--- ![](../images/ug/Create-project-icon.png) | Create Project | Opens the Project Create wizard. ![](../images/ug/Create-project-from-git-icon.png) | Create Project from Git | Opens the Import Projects from Git wizard. Learn more about Git Team work in our [article](../Project-team-work/) ![](../images/ug/Refresh-projects-icon.png) | Refresh Projects | Refreshes the projects tree to display changes caused by creating, modifying or deleting projects. ![](../images/ug/Collapse-All-icon.png) | Collapse All | Collapses the tree to the root level. ![](../images/ug/Link-with-Editor-icon.png) | Link with editor | Highlights the object in the tree that has its editor open **Note** : Button enabled when at least one editor is open, otherwise disabled. ![](../images/ug/Configure-button.png) | Preferences | Opens the Preferences window, allowing you to adjust resource locations settings specific to the Projects view. ### Context Menu¶ Right-click an object in the tree to access its context menu. For objects under the **Connections** node, see the [Database Navigator](../Database- Navigator/) documentation. Context menus for other nodes offer basic functionalities such as copy-pasting, renaming, and deleting objects, as well as property management and folder creation. #### Special Actions¶ * **Set Active Project** : Makes the selected project root node active and visible in the Database Navigator. * **Link File** and **Link Folder** : Create links to files and folders within the file system. * **Show Resource in Explorer** : Opens the project's directory in the user's file system. * **Restore from Local History...** : Opens the **Restore from Local History** window where you can select a file and its version (if multiple versions exist) for restoration. For more details on project management, consult the [Projects](../Projects/) article. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Projects/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * Projects [ Projects ](./) Table of contents * Projects benefits * Creating a project * Deleting Project * Exporting and importing projects * Export * Import * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Projects benefits * Creating a project * Deleting Project * Exporting and importing projects * Export * Import 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Projects # Projects Projects in DBeaver offer a flexible way to organize and manage your database connections, scripts, diagrams, and other resources. ## Projects benefits¶ Projects help you organize connections, resources, and workflows. Here are some scenarios where you might want to use them: * Separate different environments, like production, staging, and development, to avoid making accidental changes. * Streamline collaboration by organizing shared resources when using version control systems like Git. * Manage different credentials for the same database, such as switching between read-only and admin access easily. * Group multiple connections, scripts, and diagrams by context, making your workspace simpler to navigate. ## Creating a project¶ 1. To create a project, go to the [Projects view](../Projects-View/), and click **Create Project** button ![](../images/ug/Create-project-icon.png) in the toolbar. This opens the Project Create Wizard. ![](../images/ug/Create-project-wizard.png) 2. Enter a name for your project in the **Project name** field. 3. To use the default storage location, keep **Use default location** selected. To choose a different directory, uncheck the box, enter a new path, or click **Browse** to select a folder. 4. Click **Finish**. The new project appears in the Projects tree. Note You can’t rename or delete an active project. ## Deleting Project¶ To delete a project, in the Projects view, right-click its name in the tree and click **Delete** on the context menu. Two confirmation dialog boxes will appear one after another: 1. **Delete object** dialog box is to confirm the deletion of the project itself. Click **Yes** if you are sure you want to delete it. Otherwise, click **No**. To delete a project, right-click its name in the Projects view and select **Delete** from the context menu. You’ll see a confirmation dialog: * Confirm the deletion by clicking **Yes** or cancel by clicking **Cancel**. * To delete the project’s files (e.g., configurations, scripts) from disk, check the **Delete project contents on disk** box before confirming. Note If you have deleted a project and then re-create it with the same name, the new project picks up all the database connections of the deleted project. ## Exporting and importing projects¶ To transfer projects between environments, you can use export and import functionality. ## Export¶ 1. Go to **File - > Export -> DBeaver**. 2. Select the **Projects**. 3. Follow the steps in the export wizard to save the Project. ## Import¶ 1. On the target machine, go to **File - > Import -> DBeaver**. 2. Choose the **Projects**. 3. Follow the steps in the import wizard. Tip Exporting and importing items is helpful for sharing or backing up configurations without migrating the entire workspace. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Proxy-configuration-with-system-files/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * Proxy configuration with system files [ Proxy configuration with system files ](./) Table of contents * Configure proxy * Using system properties * Using environment variable * Using in-app configuration file * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configure proxy * Using system properties * Using environment variable * Using in-app configuration file 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. [Connection network options](/docs/dbeaver/SSH-Configuration) 5. Proxy # Proxy configuration with system files If you're behind a firewall and can't use the UI to configure proxy, you can configure proxy access using system properties, environment variables, or an in-app configuration file: * with system properties in the `dbeaver.ini` file * with a global environment variable * with an in-app configuration file ## Configure proxy¶ ### Using system properties¶ Edit your `dbeaver.ini` file and add the following lines at the end: -Dorg.eclipse.net.core.enableProxyService=false -Dhttps.proxyHost=your-proxy-server-host-name -Dhttps.proxyPort=your-proxy-server-port-number Tip For more details on finding `dbeaver.ini`, see [Configuration files](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). ### Using environment variable¶ Set the `JAVA_TOOL_OPTIONS` environment variable: -Dorg.eclipse.net.core.enableProxyService=false -Dhttps.proxyHost=your-proxy-server-host-name -Dhttps.proxyPort=your-proxy-server-port-number Warning This affects all Java applications, not just DBeaver. ### Using in-app configuration file¶ The proxy configuration file depends on your installation type. * Writable location: If DBeaver is installed in a **writable location** (like `C:\Users\USER\AppData\Local\DBeaver\`), use: C:\Users\USER\AppData\Local\DBeaverTeam\configuration\.settings\org.eclipse.core.net.prefs * Read-only location: If DBeaver is installed in a **read-only location** (like `C:\Program Files\DBeaver\`), use: C:\Users\USER\AppData\Roaming\DBeaverData\install-data\com.dbeaver.team\CLIENT-VERSION\.settings\org.eclipse.core.net.prefs Paste the following content into that file: eclipse.preferences.version=1 org.eclipse.core.net.hasMigrated=true proxyData/HTTPS/hasAuth=false proxyData/HTTPS/host=your-proxy-server-host-name proxyData/HTTPS/port=your-proxy-server-port-number Tip For plain HTTP, replace all `proxyData/HTTPS/` prefixes with `proxyData/HTTP/`. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Proxy-configuration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * Proxy configuration [ Proxy configuration ](./) Table of contents * Configure a proxy * Global proxy * Network access * Active provider * Manual proxy configuration * Drivers download * Connection proxy * Automatic proxy configuration * SOCKS * Configure proxy using system files * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configure a proxy * Global proxy * Network access * Active provider * Manual proxy configuration * Drivers download * Connection proxy * Automatic proxy configuration * SOCKS * Configure proxy using system files 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. [Connection network options](/docs/dbeaver/SSH-Configuration) 5. Proxy # Proxy configuration If you’re behind a corporate firewall or use a restricted network, you may need to configure a proxy to: * download 3rd party JDBC drivers * check for product updates * connect to external databases * activate or update a commercial license ## Configure a proxy¶ DBeaver supports two types of proxy settings: * **Global proxy** – applies to all network features in the application * **Connection proxy** – used for database connections ### Global proxy¶ #### Network access¶ If your access to license services or other online features is restricted, configure a proxy in **Network Connections** preferences. Tip If you cannot activate your subscription license then you first need to use a trial version to start DBeaver and configure a proxy. Go to **Preferences - > Connections -> Network Connections**. ![](../images/ug/network/global-proxy.png) ##### Active provider¶ The **Active Provider** setting controls how proxy settings are applied: Option | Description | Default behavior ---|---|--- **Direct** | Connects directly to the internet without using a proxy. | Use your system’s normal internet connection. **Manual** | Lets you enter proxy details manually in the **Proxy entries** section. | Select **Manual** and enter the proxy settings. **Native** | Uses the proxy configuration from your operating system or active web browser. | Select **Native** to use OS or browser settings. [See how to set browser proxy settings](https://www.wikihow.com/Change-Proxy-Settings). ##### Manual proxy configuration¶ If you choose **Manual** , you’ll need to fill in the proxy details in the **Proxy entries** table. Setting | Description | Valid values / defaults ---|---|--- **Schema** | The connection protocol type for the proxy. | `HTTP` (80), `HTTPS` (443), `SOCKS` (1080) **Host** | The hostname or IP address of the proxy server. | Any valid hostname or IP address **Port** | The proxy server port number. If left blank, the default for the selected schema is used. | 1-65535; defaults: HTTP=80, HTTPS=443, SOCKS=1080 **Auth** | Whether authentication is required for the proxy. | `Yes`, `No` **User** | Username for proxy authentication (if `Auth` is set to `Yes`). | Any valid username string **Password** | Password for proxy authentication (if `Auth` is set to `Yes`). | Any valid password string **Proxy bypass** | Hosts that should be accessed directly without using the proxy. | Any valid hostname or IP address To activate or update a license, DBeaver only needs to access `dbeaver.com`. You can ask your network administrator to add `dbeaver.com` to the whitelist. Tip You can add multiple bypass entries for hosts that should be reached without using the proxy. ### Drivers download¶ If driver downloads are blocked, configure a proxy in the **Drivers** preferences. Navigate to **Window - > Preferences -> Connections -> Drivers**. ![](../images/ug/network/drivers-proxy.png) Setting | Description ---|--- **Proxy Host** | The hostname or IP address of the proxy server used for driver downloads. **Proxy Port** | The port number of the proxy server (commonly `8080` for HTTP or `1080` for SOCKS). **User** | The username for proxy authentication (if required). **Password** | The password for proxy authentication (if required). Note These settings apply only to driver downloads. Your main database connection settings must be configured separately. Drivers are usually downloaded from the `maven.org` website. You may also ask your network administrator to add `maven.org` to the list of allowed external domains. ### Connection proxy¶ If your access to external databases is restricted, configure a proxy directly in the connection settings: 1. Start [creating a new connection](../Create-Connection/) 2. Click on the plus (![](../images/plus-button.png)) button and select **Proxy** ![](../images/ug/network/add-proxy.png) 3. The **Proxy** tab will appear at the top. You can configure it manually or use automatic detection ![](../images/ug/network/connection-proxy.png) #### Automatic proxy configuration¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. Setting | Description ---|--- **Use automatic proxy detection** | Tries to detect and apply proxy settings automatically, based on system or platform settings. **Use browser proxy settings** | Uses the proxy settings from your default web browser, if supported. **Use OS settings** | Uses the proxy settings from your operating system. **Use environment variables** | Reads proxy configuration from environment variables (e.g., `HTTP_PROXY`, `HTTPS_PROXY`). #### SOCKS¶ Setting | Description ---|--- **Host** | Hostname or IP address of the SOCKS proxy server. **Port** | SOCKS proxy port number. **User name** | Username for SOCKS proxy authentication (if required). **Password** | Password for SOCKS proxy authentication (if required). **Save Password/Passphrase** | Stores the authentication details securely for future use. **Open global network preferences** | Opens the global proxy settings page, where you can configure system-wide proxy rules. ### Configure proxy using system files¶ If you can't use the UI or need to apply proxy settings globally, you can configure proxy access using system files or environment variables. See [Proxy configuration with system files](../Proxy-configuration-with- system-files/) for details on: * editing the `dbeaver.ini` file * using `JAVA_TOOL_OPTIONS` environment variable * configuring the `.prefs` file for Eclipse-based networking Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Query-Execution-Plan/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * Query execution plan [ Query execution plan ](./) Table of contents * Simple plan view * Advanced plan view * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Simple plan view * Advanced plan view 1. [DBeaver](/docs/dbeaver) 2. [SQL Editor](/docs/dbeaver/SQL-Editor) 3. Query execution # Query execution plan This feature is supported for the following data sources: **The Execution plan for databases marked with a star is supported only in Lite, Enterprise and Ultimate editions** * MySQL * PostgreSQL * Microsoft SQL Server ![](../images/commercial.png) * Oracle * DB2 LUW * SAP HANA * Google Cloud SQL for PostgreSQL ![](../images/commercial.png) * Google Cloud SQL for SQL Server ![](../images/commercial.png) * Google Cloud SQL for MySQL ![](../images/commercial.png) * Couchbase ![](../images/commercial.png) * Firebird * Exasol * HSQLDB * Vertica ![](../images/commercial.png) * ClickHouse ![](../images/commercial.png) * AlloyDB ![](../images/commercial.png) * Netezza ![](../images/commercial.png) * OceanBase * Ocient ## Simple plan view¶ If a database driver supports the visualization of the execution plan, you can see the execution plan of the current query (under cursor) by pressing `Ctrl+Shift+E` or clicking **Explain execution plan** on the context menu or in the SQL Editor toolbar: ![](../images/ug/Exec-plan.png) (Note: toolbar is customizable. See [Toolbar Customization](../Toolbar-Customization/#sql- editor-toolbar-customization)) The execution plan command generates a tree of query execution as one of the result tabs and is convenient in estimating if the query/script is quick/optimal enough: ![](../images/ug/Execution_plan.png) You can click the rows of the execution plan to see their details (statistics) in the panels below and to the right of the plan. To reevaluate the plan, click the **Reevaluate** button (![](../images/ug/Refresh-projects-icon.png)). To see the source script on which the plan is based, click the **View Source** button (![](../images/ug/View-Source-button.png)). ## Advanced plan view¶ In DBeaver [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), and [Ultimate](../Ultimate-Edition/) editions you can use an advanced (graph) visualization of the execution plan. This visualization shows the most expensive (cost-based) plan nodes. You can hide all irrelevant nodes (see node details), use horizontal or vertical plan layouts, export it to an image or save it as JSON to send to a colleague. ![](../images/ug/Exec-plan-graph.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Query-Manager/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * Query manager [ Query manager ](./) Table of contents * Properties * Query log storage and display settings * Filters * SQL history database * Cleanup old records * Clearing query history * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Properties * Query log storage and display settings * Filters * SQL history database * Cleanup old records * Clearing query history 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # Query manager The **Query Manager** provides a comprehensive view of all SQL queries executed in DBeaver. It logs queries along with execution details such as execution time, duration, affected rows, and errors. ![](../images/ug/Query-Manager.png) The **Query Manager** allows you to: * **Show or hide** session, transactions, and queries. * **Store query logs** in a file and configure the number of displayed records. * **Filter queries** by type, time range, connection, catalog, or schema. ![](../images/commercial.png) * **Manage SQL history** by defining storage settings and enabling automatic cleanup. ![](../images/commercial.png) * **Clear query history** manually or configure automatic deletion. ![](../images/commercial.png) Note Query history is saved after a restart only in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/), and [Team](https://dbeaver.com/docs/team-edition/) Editions. To access the **Query Manager** : * Go to **Window - > Show View -> Query Manager** in the DBeaver's [menu bar](../Application-Window-Overview/#menu-bar). * Alternatively, click the arrow next to the [Transaction Log](../Transaction-Log/) button in the DBeaver's [toolbar](../Application-Window-Overview/#toolbar), then select **Query Manager** from the dropdown. ## Properties¶ To customize the **Query Manager** view, open the **context menu** in the **Query Manager** view or go to **Window - > Preferences -> Query Manager**. ![](../images/ug/Query-Manager-properties.png) Option | Description ---|--- **User queries** | Display queries manually executed by the user. **Filtered user queries** | Show queries that match specific filter criteria. **User scripts** | Include SQL scripts executed by the user. **Utility functions** | List internal system functions used by the database. **Metadata read** | Show queries that retrieve database metadata. **Metadata write (DDL)** | Display queries that modify the database structure. **Sessions** | Show active database sessions. **Transactions** | Display database transactions. **Queries** | Include executed SQL queries. Tip Click the **Refresh** button ![](../images/ug/Refresh-projects-icon.png) in the toolbar to update the **Query Manager** and see the latest queries. ### Query log storage and display settings¶ To store query logs in a file and control how many entries appear in the **Query Manager** , configure the settings in **Window - > Preferences -> Query Manager**. Setting | Description ---|--- **Max number of records to show** | Sets the maximum number of query log entries displayed in the **Query Manager**. **Save log to file(s)** | Enables query log storage. Select this option and specify the folder in **Log files folder**. **Log files folder** | Defines the location where query logs are saved. **Days to store log** | Specifies how long logs are kept before being deleted. Note Changes to storage settings take effect only after restarting the application. ### Filters¶ To filter queries in the **Query Manager** by time range, connection, catalog, or schema, open the filter settings: * Right-click in the **Query Manager** view and select **Filters**. * Click the **Filters** button ![](../images/ug/Filter-button.png) in the toolbar. Filter | Description ---|--- **Range from** | Shows queries executed after the selected date and time. **Range to** | Shows queries executed before the selected date and time. **Connection** | Filters queries by a specific database connection or shows all connections. **Catalog** | Filters queries by one or more catalogs. **Schema** | Filters queries by one or more schemas. Once you've selected the filters, use the following buttons: * **Apply Filters** – Applies the selected filters and updates the query list. * **Reset Filters** – Clears all selected filters and restores the default view. ### SQL history database¶ By default, DBeaver stores query history in a local database file. You can check its location in **Window - > Preferences -> Query Manager -> SQL History Database** or by clicking the **Database settings** button in the **Query Manager's** toolbar. * The **Database path** field shows the current location of the query history database (`qmdb` file). * This file (H2 database) contains all logged queries, their execution times, and related metadata. Note Modifying or deleting this file may result in losing the query history. #### Cleanup old records¶ DBeaver provides an option to automatically remove old query history records. To enable this feature: 1. Navigate to **Window - > Preferences -> General -> Query Manager -> SQL History Database** 2. Select the **Cleanup old records** checkbox. 3. Specify the **Days to keep history**. It will retain only the records from the specified number of days and delete older entries. 4. Restart the DBeaver. Tip If you set **Days to keep history** to 1, DBeaver will retain only the records from the last day, removing everything older than that during cleanup. ## Clearing query history¶ You can erase all entries from the **Query Manager** by clicking the **Clear Log** button ![](../images/ug/Clear-log-button.png) in the view's toolbar. * In **Community Edition** , the query history is automatically deleted after a restart. * You can clear history manually by going to **Help - > Clear History** and selecting **Query Log History**. ![](../images/commercial.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Query-Trace-Panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * Query trace Panel [ Query trace Panel ](./) Table of contents * Trace details * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Trace details 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # Query trace Panel The **Query trace** panel helps you analyze how a query runs inside the database. It tracks read and write operations, timing, and the nodes involved, giving a detailed view of query execution across the cluster. Note This feature is specific to [Cassandra](../Cassandra/) and Yugabyte CQL. ## Trace details¶ Name | Description ---|--- **Event** | Describes the specific action or stage of the query being logged. **Time** | The timestamp or duration (in milliseconds) indicating when the event occurred or its length. **Source** | The IP address or identifier of the node where the event originated. **Thread** | The thread or process within the source that executed the event. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Quick-start-with-AI-Assistance/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * Quick start with AI [ Quick start with AI ](./) Table of contents * Start in the SQL Editor * Talk instead of typing * Generate directly in the editor with @ai * Understand what the query is doing * Get inline AI query suggestions * Use functions * Fix an error when the query fails * Describe a database object when you need context * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Start in the SQL Editor * Talk instead of typing * Generate directly in the editor with @ai * Understand what the query is doing * Get inline AI query suggestions * Use functions * Fix an error when the query fails * Describe a database object when you need context 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. Tutorials # Quick start with AI Work through a typical flow in the SQL editor using AI assistant - from writing a query, to fixing an error, to understanding objects. To get started, open **Window - > Preferences -> General -> AI**, choose a [provider](../AI-Smart-Assistance/#supported-providers), and paste your API token. Then adjust [preferences](../AI-Assistance-settings/) to match your workflow. ![](../images/ai/ai-token-settings.png) Tip Different vendors have different limits, models, and regions. Pick what fits your data policy and budget. ## Start in the SQL Editor¶ 1. Open the [SQL editor](../SQL-Editor/). 2. Click **AI** on the main toolbar, or from the editor toolbar. ![](../images/ai/tutorial/quickstart-chat.png) 3. Pick a **connection**. ![](../images/ai/tutorial/pick-connection.png) Info Optionally set a [scope](../AI-chat/#defining-the-scope) to improve accuracy on large instances. 4. Type what you need in AI chat. 5. Execute or refine. For details, see [AI chat](../AI-chat/). ### Talk instead of typing¶ Prefer voice? Use speech recognition in AI Chat to turn speech into a prompt, review, and send. 1. Open AI chat 2. Click the microphone ![](../images/ai/ai-speech-recognition-button.png), speak, edit if needed 3. Execute or refine. For more, see [AI speech recognition](../AI-speech-recognition/). ### Generate directly in the editor with @ai¶ Want to stay focused in the SQL editor? Use `@ai` when you don’t need the full chat flow. 1. In the SQL editor, enter `@ai your request...` 2. Execute and review ![](../images/ai/tutorial/quickstart-ai-command.png) Warning Depending on your [execution settings](../AI-Assistance-settings/#ai-query- execution), AI commands may run without preview. Enable confirmations if you prefer to review first. When the SQL looks right, validate it or quickly understand its intent before you run it on real data. For more, see [AI command](../AI-command/). #### Understand what the query is doing¶ Need a clear explanation, risks, or edge cases? 1. Select the SQL 2. Right-click, **AI commands - > Explain query using AI** ![](../images/ai/explain-query-using-ai.png) 3. Read the explanation in AI chat, and ask follow-ups For details, see [Explain query using AI](../AI-query-explanation/). ### Get inline AI query suggestions¶ Prefer autocomplete-style help? Let AI suggest a full statement as ghost text based on a short intent comment. 1. Write your query in the SQL editor 2. Add a brief intent comment Example -- find flight with flight_id equal or less then 1230 SELECT 3. Right-click, **AI commands - > Show AI Suggestion text** 4. Press `Enter` to insert See [AI query suggestion](../AI-query-suggestion/) for more details. ## Use functions¶ Run actions through plain language. AI can open tools, compare data, read a few sample rows, or export tables without you clicking through menus. Examples * compare stage.Album schema with prod.Album schema * export these results as CSV * import a CSV into stage.Album For details, see [AI functions](../Data-Transfer-Actions/). ## Fix an error when the query fails¶ If the SQL fails, use AI to explain and repair it in one pass. 1. Click **Explain and Fix** ![](../images/ai/ai-explain-and-fix.png) 2. Apply the fix ![](../images/ai/ai-chat-explain-error.png) For the flow, see [AI error explanation](../AI-error-explanation/). ## Describe a database object when you need context¶ Ask AI to describe a table, view, or other object in plain language. The result opens in AI chat. 1. Open [Database Navigator](../Database-Navigator/) or [Properties editor](../Properties-Editor/) 2. Right-click the object, **Describe database object** ![](../images/ai/tutorial/quickstart-describe-object.png) 3. Review the description in AI chat, and ask follow-ups ![](../images/ai/ai-describe-db-object.png) For supported objects and flow, see [Describe database object](../AI-smart- metadata-description/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Redis/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * Redis [ Redis ](./) Table of contents * Redis specialty * Setting Up * Redis connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Redis features in DBeaver * Browsing keys * Executing commands * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Redis specialty * Setting Up * Redis connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Redis features in DBeaver * Browsing keys * Executing commands 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. Classic # Redis Note This driver is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. This guide provides instructions on how to set up and use Redis with DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Redis` option to connect to the Redis. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/redis/redis-drivers.png) ## Redis specialty¶ Redis is an open-source, in-memory data structure store, used as a database, cache, and message broker. It supports various data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes, and streams. Redis has built-in replication, Lua scripting, LRU eviction, transactions, and different levels of on-disk persistence. Additionally, Redis offers high availability via Redis Sentinel and automatic partitioning with Redis Cluster. Redis is particularly well-suited for real-time applications like leaderboards, session stores, real-time analytics, and geospatial services due to its fast performance and support for complex data types and operations. For detailed information on Redis and its features, please refer to the [official documentation](https://redis.io/documentation). ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, Kubernetes and SSL. ### Redis connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Redis database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Redis database. 1. The **Main** tab of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/redis/redis-connection-main.png) Field | Description ---|--- **Connect by (Manual/URL)** | Choose whether you want to connect using a host or a URL. **URL** | If you are connecting via URL, enter the URL of your Redis database here. This field is disabled if you're connecting via the host. **Host** | If you are connecting via host, enter the host address of your Redis database here. **Database** | Enter the database number you want to connect to. **Port** | Enter the port number for your Redis database. The default Redis port is `6379`. **Deployment** | Select the type of Redis deployment for your connection. Options include: | \- **Standalone** : A single-node Redis deployment. | \- **Redis Cluster** : A multi-node Redis deployment for higher performance and fault tolerance. | \- **Redis Sentinel** : A system designed to help manage Redis instances, providing high availability and monitoring services. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Database-Native/) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) \- Redis Sentinel (coming soon) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection settings** | Customize connection settings: | **Connect timeout** : Specify the duration, in milliseconds, the application waits to establish a connection before it times out. `10000` milliseconds is the default value. | **Socket timeout** : Set the time, in milliseconds, the application waits for a server response to a query. The default setting here is `100000` milliseconds. | **Send client name** : Check this option to transmit the client's name to the server when connecting. Some Redis servers do not support this feature, which may cause the connection attempt to fail. **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be auto-filled based on your selected driver type. **Driver Settings** | If there are any specific driver settings, configure them here. 2. The **Advanced** tab of the connection settings offers additional options that allow you to customize the keys settings. ![](../images/database/redis/redis-connection-second-page.png) Setting | Description | Default Value ---|---|--- **Key group divider** | Determines the delimiter used to group keys in the keyspace. | `:` **Max keys read** | Limits the number of keys to read. | `10000` **Max cache read** | Specifies the number of keys to read with pattern (cache). | `100000` **Key filters** | Allows you to define patterns to include or exclude certain keys. | `*` #### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Redis database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) #### Secure Connection Configurations¶ DBeaver supports secure connections to your Redis database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , **AWS SSM** and **SSL** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**SSL Configuration**](../SSL-Configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) * [**AWS SSM**](../AWS-SSM-Configuration/) #### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Redis features in DBeaver¶ DBeaver is not limited to typical SQL tasks. It also includes numerous additional features compatible with Redis, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/) | [Data Export](../Data-export/) Task Management | [Task Management](../Task-Management/) ### Browsing keys¶ Redis keys are often viewed and edited as a simple list. However, when dealing with a large number of keys, which can run into millions or billions, a list view is not always practical or possible. DBeaver offers a hierarchical view of Redis keys. Although Redis itself does not inherently support hierarchical data structures, it is common practice to organize keys into groups using specific delimiters like commas, dashes, or colons. DBeaver leverages these naming patterns to display keys in a hierarchical format. You can configure the group separator in the connection properties. The key browser feature is useful, but for databases with a large key count, locating a specific key through the navigator might be challenging. In such cases, using the SQL editor with Redis commands is the most effective method to manage keys. ### Executing commands¶ Redis operates differently from traditional SQL databases. It uses built-in commands and LUA scripting for operations. To execute Redis commands, use the syntax similar to the Redis command line shell: SET mykey "Hello" This command will set the value of `mykey` to `Hello`. To run this command in DBeaver, you would type it into the SQL editor and execute it using either `CTRL+Enter` or `ALT+X`. Info To learn more about Redis commands, refer to the [official Redis commands documentation](https://redis.io/commands). For LUA script execution, enclose the script in curly braces {} and execute it as a single statement. If your LUA script includes empty lines or special characters, highlight the script text before executing it. For instance: { -- Retrieve the value of a Redis key local key = 'key1038' -- Specify the key you want to retrieve local value = redis.call('GET', key) return value } Info For LUA scripting in Redis, see [LUA scripts in Redis](https://redis.io/commands/eval). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/References-Panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * References Panel [ References Panel ](./) Table of contents * View referenced data * View referencing data * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * View referenced data * View referencing data 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # References Panel The **References** panel shows related records from other tables connected by foreign keys. It helps you explore table relationships directly in the [Data editor](../Data-Editor/). Info To open the **References** click **Panels - > References** on the [Right sidebar](../Data-Editor/#right-sidebar) or use [shortcut](../Shortcuts/#panels). ![](../images/ug/reference-panel-list.png) ## View referenced data¶ If the current table references another table using a foreign key, the panel displays the matching row from that table. In this case, **record view** is enabled by default, but you can turn it off as in a regular data viewer. ![](../images/ug/references-panel-fk.png) Tip Click **Open** on the panel toolbar to open the referenced table in a new tab. ## View referencing data¶ If another table references the current one, the panel shows all rows that refer to the selected primary key in the current table. ![](../images/ug/references-panel-references.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Reset-UI-settings/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * Reset UI settings [ Reset UI settings ](./) Table of contents * Reset settings * Manual reset * Clear History * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Reset settings * Manual reset * Clear History 1. [DBeaver](/docs/dbeaver) 2. DBeaver configuration # Reset UI settings ## Reset settings¶ You might want to reset settings in the following cases: * Shortcuts suddenly stop working * Theme colors are messed up * Broken or invalid localization * Other UI elements aren't shown anymore This can happen due to the following reasons: * After multiple version upgrades * After switching between newer and older versions * After an incorrect shutdown You can perform a reset using the `Help` ⇒ `Reset Settings...` action. Be careful this will reset **all** UI settings and other user preferences, including: \- resource cache, imported projects \- layout of menus, toolbars, windows, editors \- theme, colors, and fonts \- other settings from installed third- party plugins After choosing the appropriate options, DBeaver will restart and greet you with a fresh workspace. ## Manual reset¶ If you cannot launch DBeaver, you can reset the workspace manually. Be careful only delete any other files if you know what you're doing, and follow the steps below. To do so, do the following: * On **Windows** , open Explorer and navigate to `%APPDATA%\DBeaverData\workspace6\.metadata\.plugins` * On **macOS** , open Finder and navigate to `~/Library/DBeaverData/workspace6/.metadata/.plugins` * On **Linux** , open file explorer and navigate to `$XDG_DATA_HOME/DBeaverData/workspace6/.metadata/.plugins` You can try deleting the file `workbench.xmi` located in the `org.eclipse.e4.workbench` directory. If it didn't help, try deleting all files in the `.plugins` directory or that directory itself. ## Clear History¶ You can clean up the workspace by deleting redundant files that accumulate as you use DBeaver. 1. Navigate to **Help - > Clear History...** action. 2. Choose one or more options provided below. Name | Description ---|--- Task run history | Contains information about previously run tasks along with logs collected during their execution Query log history ![](../images/commercial.png) | Contains information about previously run (user and meta) SQL queries 3. Click the **Apply and Restart** button to continue. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Reset-workspace/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](./) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Resetting your workspace The article has been moved to [Reset UI settings](../Reset-UI-settings/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Result-Details-Panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * Result details Panel [ Result details Panel ](./) Table of contents * Details * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Details 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # Result details Panel Info This panel is specific to [BigQuery](../Database-driver-BigQuery/). The **Result details** panel shows execution statistics for a `SELECT` query in the [Data editor](../Data-Editor/). It helps you understand query performance, data volume, and processing costs. ![](../images/ug/Result-details-panels-overview.png) ## Details¶ **Result details** panel includes the following metrics: Name | Description ---|--- **Job** | The unique identifier of the job. **Location** | The regional location of the data you have queried. **Project** | The project within which the query was executed. **DML affected rows** | The number of rows affected by a Data Manipulation Language (DML) statement. **Fetched from cache** | Indicates if the results were retrieved from the cache. `true` means no additional costs are incurred for data processing. **Total rows** | The number of rows returned by the query. **Total bytes processed** | The amount of data processed by the query. This is important for cost calculations as costs are incurred based on the amount of data processed. If the **Total bytes processed** is zero, it indicates that the query results were served from the cache, which does not incur costs. **Transaction id** | The identifier for the transaction within which the query was executed, if applicable. **Total bytes billed** | The total bytes billed for the query, which might be different from the bytes processed if discounts or caps are applied. **Total modified partitions** | The total number of partitions that were modified as a result of the query execution. **Total slot ms** | The total number of slot milliseconds consumed by the query. **Query** | The SQL query statement that was executed. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Assist-and-Auto-Complete/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * SQL Assist and Auto Complete [ SQL Assist and Auto Complete ](./) Table of contents * How to use SQL Assist * Quick Fix * Completion engines * Hippie Engine * Customize * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How to use SQL Assist * Quick Fix * Completion engines * Hippie Engine * Customize 1. [DBeaver](/docs/dbeaver) 2. [SQL Editor](/docs/dbeaver/SQL-Editor) 3. Query development and assistance # SQL Assist and Auto Complete The SQL Assist feature provides auto-completion of database object names and SQL commands, and other keywords in queries. ## How to use SQL Assist¶ 1. Start typing an SQL keyword or object name in the editor 2. Press `Ctrl+Space` to see completion suggestions ![](../images/ug/SQL-Assist.png) * To complete based on the last entered identifier, either double-click the suggestion or press `Ctrl+Shift+Space` * After an asterisk (`*`) in queries like `SELECT * FROM tableName`, press `Ctrl+Space` to expand into all columns * You can also right-click in the query and choose **SQL Assist** from the context menu ## Quick Fix¶ Also, you can use SQL Assist to fix errors. When the editor detects a problem (for example, an invalid column reference), it shows an annotation next to the SQL code. Note AI assistant must be activated first. [Learn how to enable it](../AI- Assistance-settings/#ai-assistant-setup). 1. Hover over the annotation to open **Quick Fix** , or press `Ctrl+1` ![](../images/ug/SQL-Assist-Quick-fix.png) 2. Click **Explain and Fix** 3. [AI Chat](../AI-chat/) opens with a detailed explanation of the error and a suggested corrected query. ## Completion engines¶ DBeaver offers three SQL completion engines. You can switch between them in **Window** -> **Preferences** -> **Editor** -> **SQL Editor** -> **Code Completion**. * **Semantic (recommended)** \- provides the most accurate and context-aware suggestions by analyzing the entire SQL structure and lexical scopes. It improves completion accuracy but may not work correctly with certain database-specific syntax. It relies on a generalized SQL grammar and requires **Enable semantic analysis** and **Read database table/columns for semantic analysis** to be enabled in [Code Editor](../SQL-Code-Editor/) settings. * **Legacy** \- a more straightforward completion engine that suggests SQL elements based only on their position in the query. This can sometimes lead to incorrect or incomplete suggestions, especially in subqueries. * **Combined** \- merges suggestions from **Semantic** and **Legacy** engines. It enhances completion coverage by including suggestions not yet available in **Semantic**. However, since both engines run simultaneously, it may consume more resources, though this is usually noticeable only in very large queries. Note The **Semantic** engine is actively being improved, but if you encounter issues, switching to **Legacy** may provide more stable behavior. We still recommend using **Semantic** for the best overall experience. ## Hippie Engine¶ Hippie Engine provides autocompletion based on information from the current script file. It scans files looking for words and adds proposals based on similarity with the given string. It can be toggled on or off in the **Code Completion** preferences. ## Customize¶ You can customize your SQL Assist and Auto Complete by navigating to **Window** -> **Preferences** -> **Editor** -> **SQL Editor** -> **Code Completion** , optimizing the performance of the auto-completion feature. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Code-Editor/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * SQL code Editor [ SQL code Editor ](./) Table of contents * Configuring SQL Code Editor settings * Miscellaneous settings * Query analysis settings * Auto close settings * Auto format settings * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configuring SQL Code Editor settings * Miscellaneous settings * Query analysis settings * Auto close settings * Auto format settings 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # SQL code Editor The SQL Code Editor within DBeaver's SQL Editor provides you with advanced functionalities for SQL script management. This includes displaying problem markers, automatic closing of quotes and brackets, semantic analysis, and more. This article explores the settings of the SQL Code Editor, focusing on how they enhance the [Script panel's](../SQL-Editor/#script-panel) behavior and ensure efficient management of your SQL code. ## Configuring SQL Code Editor settings¶ To configure the SQL Script panel behavior, navigate to **Window - > Preferences -> Editors -> SQL Editor -> Code Editor**. ![](../images/ug/Code-editor-preferences.png) Further sections provide descriptions of the SQL Script panel settings. ### Miscellaneous settings¶ Setting | Description ---|--- **Folding enabled** | Use folding in SQL scripts. **Smart caret positioning in SQL identifiers** | Respects underscore and other identifier parts to navigate with cursor. **Mark occurrences of word under cursor** | Mark occurrences of current word in the current SQL file. **Mark occurrences of the selected word** | Mark occurrences of the selected word in the current SQL file. **Show problem markers** | Shows individual problem markers near the failed queries and highlights the problematic segment of it in the editor. If disabled, selects the problematic segment in the editor. ### Query analysis settings¶ Setting | Description ---|--- **Enable semantic analysis** | Highlight anything treated as table or column name and resolve all the aliases and table names according to `FROM` clauses. **Read database table/columns for semantic analysis** | May be an expensive operation. Validate all the table and column names with respect to real database objects. This option is only available when **Enable semantic analysis** is activated. * The **Enable semantic analysis** feature highlights column names, their aliases, table names, and schema names. ![](../images/ug/Query-analysis-example.png) In instances where a selection list item is absent from the `FROM` clause, it is indicated with a red highlight. For example, the column `b.id` in the following SQL script will be highlighted, indicating it is missing from the `FROM` clause, thereby pinpointing a potential issue within the script. ![](../images/ug/Query-analysis-missing-alias-error-example.png) * The **Read database table/columns for semantic analysis** feature extends to verifying the existence of database objects. If an object referenced in the script does not exist or is not recognized in the database metadata, it is marked with a highlight. For example, if a script attempts to query a nonexistent column `Biography` as shown below, it will be highlighted to indicate that the column does not exist in the current database context: ![](../images/ug/Query-analysis-non-existing-column-error-example.png) ### Auto close settings¶ Setting | Description ---|--- **Single quotes** | Automatically closes a single quote mark with another single quote when the first one is typed. **Double quotes** | Automatically closes a double quote mark with another double quote when the first one is typed. **Brackets** | Automatically closes a bracket with the corresponding closing bracket when the first one is typed. ### Auto format settings¶ Setting | Tooltip Description ---|--- **Convert keyword case** | Auto-convert keywords to upper/lower case on enter. **Extract SQL from source code** | On source code paste will remove all source language elements like quotes, `+`, `\n`, etc. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Editor/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * SQL Editor [ SQL Editor ](./) Table of contents * Getting started * SQL Editor overview * Script panel * Spelling * Hyperlinks * Highlighting * Toolbar * Results Panel * Multiple results in one tab * Additional features * Active Database * Layout Adjustment * Outline * Error indication * Explain errors with AI * Features summary * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Getting started * SQL Editor overview * Script panel * Spelling * Hyperlinks * Highlighting * Toolbar * Results Panel * Multiple results in one tab * Additional features * Active Database * Layout Adjustment * Outline * Error indication * Explain errors with AI * Features summary 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # SQL Editor With the SQL Editor in DBeaver, you can write and execute multiple SQL scripts within a single database connection, save them as files, and reuse them later. ## Getting started¶ To start working with the SQL Editor, you have several options: 1. **Via Database Navigator** : * Navigate to your desired database connection in the [Database Navigator](../Database-Navigator/) view. * Press `F4` or go to **SQL Editor** -> **Open SQL script** from the main menu, or right-click on the connection and choose **Open SQL script** from the context menu. * A **Choose SQL Script** window appears. Click any script to open it in a new tab. 2. **Open Recent SQL script** : * Right-click on your database connection and select **SQL Editor** -> **Recent SQL script** from the context menu or go to **SQL Editor** -> **Recent SQL script** from the main menu. Alternatively use the `Ctrl+Enter` shortcut in the **Database Navigator** view. * A **Choose SQL Script** window appears. Click any script to open it in a new tab. 3. **Create a New SQL Script** : * Navigate to **SQL Editor - > New SQL Editor** on the main menu. * Press `F3` and click **New Script** in the **Choose SQL Script** window. Note SQL Editor for a connection is different from SQL console for a table or view. Unlike the console, it can save scripts and changes made to them. You can see all your saved SQL scripts in the [Project Explorer](../Project- Explorer/) view in the **Scripts** folder. ## SQL Editor overview¶ The SQL Editor contains the Script panel, the Toolbar, and the Result panel. ![](../images/ug/SQL-Editor.png) Tip You can open the SQL editor preferences by pressing `Alt+Enter` or right-click and navigate to **Preferences**. ### Script panel¶ The Script Panel is the primary area where you can write, edit, and manage your SQL scripts. It provides basic text editing features with the added benefits of specialized functionalities tailored for SQL development: #### Spelling¶ The panel includes a spelling checker to identify and highlight misspelled words, assisting you in maintaining the quality of your scripts. For more information check out our [article](../Spelling/). #### Hyperlinks¶ You can press and hold `Ctrl` and at the same time move the mouse over the SQL text. If DBeaver recognizes some identifier as a table/view name, it presents it as a hyperlink. You can click the hyperlink to open this object`s editor: ![](../images/ug/SQL-Editor-hyperlink.png) #### Highlighting¶ DBeaver uses SQL syntax highlighting which depends on the database associated with the script. Different databases have different sets of reserved keywords and system functions. For more information, see the relevant section on highlighting settings in our article on [SQL Code Editor](../SQL-Code- Editor/). ### Toolbar¶ The toolbar is customizable and contains buttons for commonly used commands. For more information on customization, see [our article on toolbar customization](../Toolbar-Customization/#sql-editor-toolbar-customization). ### Results Panel¶ The results panel displays tabs with results in various formats. The tabs resulting from script execution represent instances of the [Data Editor](../Data-Editor/). You can create, edit and execute SQL scripts in the script panel and then see the results in the result tabs. Tip You can also visualize query results as charts to explore data patterns. For details, see [Charts](../Managing-Charts/). #### Multiple results in one tab¶ You can view and manage multiple query results within a single tab. ![](../images/ug/sql-editor-multiple-tabs.png) To use the Multiple results feature in the SQL Editor, follow these steps: 1. **Add Toolbar Item** : Add the **Show multiple results in a single tab** ![](../images/ug/toggle-execution-result-orientation-button.png) to the SQL Editor toolbar. [Read more](../Toolbar-Customization/) on Toolbar customization. **Alternatively** : * Right-click in the SQL Editor window and navigate to **Execute - > Layout -> Show multiple results in a single tab**. * Navigate to **SQL Editor** -> **Show multiple results in a single tab**. 2. **Toggle** : Click the toolbar item to activate multiple query results view. 3. **View results** : * To view multiple results in a single tab, execute queries using the **Execute SQL Script** button ![](../images/ug/execute-button.png). * You can collapse some result sets according to your preference by clicking the arrow button ![](../images/ug/toggle-button.png). Important When using two or more queries in parallel, exercise caution as this may lead to client UI freeze, high database server load, or transaction deadlock. ## Additional features¶ ### Active Database¶ You can change the connection associated with the current SQL editor or change the active database/schema, at the same time retaining the SQL text. To change the connection, press `Ctrl+9` or click the **Active datasource** box on DBeaver`s main toolbar: ![](../images/ug/Active-Connection-change.png) The Select Data Source dialog box opens. In the tree of connections, click the required connection and then click **Select**. To disassociate the SQL Editor with any connection, click **None** : ![](../images/ug/Connection-change-dialog.png) To change the active schema, press `Ctrl+0` or click the **Active Catalog/Schema** box in DBeaver`s main toolbar: ![](../images/ug/Active-Schema-Change.png) The Choose catalog/schema dialog box opens. In the list of schemas, double- click the required schema: ![](../images/ug/Schema-change-dialog.png) If there are many schemas, and they do not fit in the dialog box use the search field ![](../images/ug/Search-field.png) to find the schema. To configure the set of columns to be visible for each schema in the dialog box, click the **Configure columns** button ![](../images/ug/Configure- columns-visibility-icon.png). Tip You can easily associate the SQL Editor with the connection that is currently in focus in the Database Navigator (the focus can be on any object of the connection - a table, a folder, etc.) - click the **Link with editor** ![](../images/ug/Link-with-Editor-icon.png) or use the shortcut `Ctrl+Shift+,`. ### Layout Adjustment¶ You can modify the layout of the SQL Editor by showing/hiding the results panel and changing the horizontal/vertical position of the panes. * To toggle (hide/show) the results panel, press `CTRL+6` or right-click anywhere in the script pane and, on the context menu, click **Layout** -> **Toggle results panel**. * To maximize the results panel, press `CTRL+Shift+T`, or double-click the results tab name, or right-click anywhere in the script panel and, on the context menu, click **Layout** -> **Maximize results panel**. * To switch between the script panel and the results pane, press `Ctrl+Alt+T` or right-click anywhere in the script panel and, on the context menu, click **Layout** -> **Switch active panel**. To position both panels horizontally, right-click anywhere in the script panel and, on the context menu, click **Layout** -> **Horizontal**. To position both panels vertically, right-click anywhere in the script panel and, on the context menu, click **Layout** -> **Vertical**. ### Outline¶ You can use the Outline feature in the SQL Editor to get a structured view of your SQL query. ![](../images/ug/outline-feature-overview.png) Here's how you can access the Outline: * Use the shortcut: `Alt+Shift+Q, O` (on macOS use `⌥⌘Q O`). * Click on the **Toggle Outline** button ![](../images/ug/toggle-outline-button.png) in the SQL Editor bottom toolbar. * Select **Panels - > Toggle outline** from the [Script panel](./#script-panel). * Select **SQL Editor - > Panels -> Toggle outline** from [Menu bar](../Application-Window-Overview/#menu-bar). When you open the Outline, it shows a tree structure of your SQL query. This representation reflects the components of your SQL query and is beneficial for analyzing and moving through large queries. The relationship between the Outline and SQL Editor is interactive: * The tree selection in the Outline automatically follows the cursor movement in the SQL Editor. This synchronization helps you identify the specific section of the query you are editing within its overall structure. * Alternatively, clicking an item in the Outline tree will highlight the corresponding fragment in the SQL Editor, facilitating swift navigation to different parts of your SQL query. ### Error indication¶ The SQL Editor indicates errors during the execution of an incorrect query by displaying an error icon ![](../images/ug/sql-editor-error-icon.png) to the left of the query text. Hovering over this icon reveals a tooltip. * **Tooltip** : A tooltip will show a detailed list of errors. * **Error list** : Moving the mouse over an error in the list will highlight it directly in the query. * **Error types** : The SQL Editor detects and displays server issues, semantic errors, and spelling mistakes. Note Semantic errors are displayed only when the **Enable semantic analysis** setting is activated and the database in use is relational. For more information, see [Query analysis settings](../SQL-Code-Editor/#query-analysis- settings). ![](../images/ug/sql-editor-error-highlighting.png) #### Explain errors with AI¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. You can use AI to explain and fix errors after query execution. Info For details, see [AI error explanation](../AI-error-explanation/). ## Features summary¶ The SQL Editor offers a variety of advanced features to enhance your scripting experience. * **[SQL templates](../SQL-Templates/)** : Insert pre-defined SQL code snippets for quick access. * **[SQL assist and auto-complete](../SQL-Assist-and-Auto-Complete/)** : Complete SQL queries with suggested options as you type. * **[AI SQL assistance](../AI-Smart-Assistance/)** : Get AI-powered suggestions for optimizations and best practices. * **[SQL formatting](../SQL-Formatting/)** : Automatically format SQL queries to enhance readability. * **[SQL execution](../SQL-Execution/)** : Choose from various options to execute SQL queries. * **[SQL terminal](../SQL-Terminal/)** : Use a terminal interface for executing SQL commands directly. * **[Variables](../Variables-panel/)** : Manage variables within SQL queries. _For information on this feature, see also[Pre-configured Variables](../Pre-configured-Variables/)._ * **[Query execution plan](../Query-Execution-Plan/)** : Visualize the execution plan of SQL queries for better insight. * **[Visual query builder](../Visual-Query-Builder/)** : Use a graphical interface to build SQL queries. * **[Script management](../Script-Management/)** : Manage multiple SQL scripts within a single editor interface. * **[Client-side commands](../Client-Side-Scripting/)** : Execute client-side commands directly within the editor. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Execution/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * SQL execution [ SQL execution ](./) Table of contents * Result tabs * Naming * Pinning * Detaching * SQL Expression Evaluation * Row Count * Query Export * Parameters and variables * Parameters * Common * Scripts * Delimiters * Variables * Dynamic parameters binding * Miscellaneous * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Result tabs * Naming * Pinning * Detaching * SQL Expression Evaluation * Row Count * Query Export * Parameters and variables * Parameters * Common * Scripts * Delimiters * Variables * Dynamic parameters binding * Miscellaneous 1. [DBeaver](/docs/dbeaver) 2. [SQL Editor](/docs/dbeaver/SQL-Editor) 3. Query execution # SQL execution You can execute one query, a highlighted portion of a script, or a whole script. You can execute them using the following: * shortcut key combinations (see details further in this article) * tools in the main toolbar: ![](../images/ug/Execute-buttons.png) Note Toolbar is customizable. See [Toolbar Customization](../Toolbar- Customization/#sql-editor-toolbar-customization) * context menu (right-click the query): ![](../images/ug/execute-context-menu.png) * DBeaver main menu: ![](../images/ug/Execute-main-menu.png) To execute a query under the cursor or selected text, press `Ctrl+Enter` or right-click the query and click **Execute** -> **Execute SQL Statement** on the context menu. You can do the same using the main toolbar or main menu: **SQL Editor** -> **Execute SQL Statement**. This executes the SQL query under the cursor or selected text and fills the results pane with the query results. To execute a query under the cursor in a separate tab, press `CTRL+\ ` or right-click the query and click **Execute** -> **Execute SQL in new tab** on the context menu. The same can be done using the main toolbar or the main menu: **SQL Editor** -> **Execute SQL in new tab**. This executes the SQL query under the cursor or selected text and creates a new results tab. To execute the whole script, press `Alt+X` or click **Execute** -> **Execute SQL Script** on the context menu or **SQL Editor** -> **Execute SQL Script** on the main menu or in the main toolbar. This executes all queries in the current editor (or selected queries) as a script. DBeaver parses queries one by one using a statement delimiter (“;” by default) and executes them consecutively. For these settings, see the Delimiter preferences section. To execute the script natively, press `Alt+N` or click **Execute** -> **Execute SQL Script natively** on the context menu or **SQL Editor** -> **Execute SQL Script natively** on the main menu or in the main toolbar. Upon activation, a setup wizard is launched, which allows you to configure the parameters for script execution before the script is launched in the native client like PLSQL, MySQL, or SQLPlus. The results are displayed in a text field in the format of console output. It is handy when functions are not supported by DBeaver drivers and require more specialized clients or when the function is weighty, and a faster client is needed. Note This function is available for MySQL/Maria, Oracle, and PostgreSQL and may require additional software installation for each database. To execute a script opening, each query results in a separate tab, press `Ctrl+Alt+Shift+X` or click **Execute** -> **Execute Statements In Separate Tabs** on the context menu or **SQL Editor** -> **Execute Statements In Separate Tabs** on the main menu or in the main toolbar. It executes all queries in the script but opens multiple result tabs. Each script query is executed in a separate thread (that is, all queries are executed simultaneously). Important Executing a massive script with numerous queries can result in unforeseen problems. ## Result tabs¶ A single query may generate several result sets represented by tabs. These tabs are linked to the query they are executed from. * to close an individual tab, press `CTRL+Shift+\` or middle-click on a tab header * to close all tabs expect current, click **Close all result tabs except this** on the context menu of this tab * to close all tabs of the desired query, click **Close all result tabs of same query** on the context menu of this tab ### Naming¶ A tab is often named after the primary table of your query. For example, after executing the following query you will see a single tab called `Album` (assuming that your database has a table called `Album`): SELECT * FROM Album; If a query has joins or, in other words, has multiple source tables, a `(+)` is shown right to the table name. The following query will result in a tab called `Album(+)`: SELECT * FROM Album al, Artist ar WHERE al.AlbumId = ar.ArtistId; Additionally, you can change the name of a given tab via its context menu or by using a special comment: -- title: DBeaver is cool SELECT * FROM Album; In other cases, tabs are named in the form of `Results <**A** > (<**B** >)`, where: * **A** is _an index of query_ * **B** is _an index of the result set of this query_ ### Pinning¶ Tabs can be moved around by dragging them with a mouse and pinned using the **Pin tab** on the context menu of the desired tab. Pinned tabs are stacked on the left. They can be moved among other pinned tabs but can't be mixed with unpinned tabs. Pinned tabs cannot be closed without being unpinned first and cannot be overwritten by executing a query (by making this tab active). ### Detaching¶ Tabs can be detached from the SQL editor into a separate view using the **Detach Tab** action found in the context menu of the desired tab. After the tab is detached, you can rearrange and move it anywhere you want (for example, you can put two tabs side-by-side for comparison). Additionally, you can detach it from the application window using **Detach** found in the context menu of an already detached tab. After the tab is detached, it's still synchronized with the SQL editor, meaning you can edit and refresh data as long as the SQL editor that produced that tab is open. Once you close it, tabs become read-only. ## SQL Expression Evaluation¶ To evaluate an SQL expression, right-click the expression and click **Execute - > Evaluate SQL expression** on the context menu. This command performs a query of **SELECT [expression] FROM DUAL** type: ![](../images/ug/Evaluate-SQL-expression.png) ## Row Count¶ If you want to know how many rows an SQL query will produce, you need to apply the Row Count feature – highlight and right-click the SQL text and then click **Execute** -> **Select row count** on the context menu: ![](../images/ug/Row-Count.png) ## Query Export¶ It might be useful to export a query if you have a long-running query, and you do not need to see its results in the results panel. You can directly export the current query results to a file/table by right-clicking the query and then clicking **Execute** -> **Export From Query** on the context menu: ![](../images/ug/Export-from-Query.png) The Data transfer wizard opens. Go through its steps to complete the export of the query. ![](../images/ug/Data-transfer-window.png) ## Parameters and variables¶ In DBeaver, parameters are used within SQL queries as placeholders, prompting for user input at query execution. Info Variables, defined with the `@set` command or through the [Variables panel](../Variables-panel/), substitute placeholders with predefined values, enabling scripts to run without manual input each time. To customize parameter and variable behavior in DBeaver, access the settings through **Window - > Preferences -> Editors -> SQL Editor -> SQL Processing**. ### Parameters¶ Setting | Description ---|--- **Enable SQL parameters** | Allows the use of named parameters within SQL queries. **Anonymous SQL parameters** | Permits the usage of unnamed parameters, enabling the SQL editor to recognize placeholders denoted by the character specified in the **Anonymous parameter mark** field. **Anonymous parameter mark** | Sets the symbol for anonymous parameters (default `?`). **Named parameter prefix** | Defines the prefix for named parameters (default `:`). **Control command prefix** | Specifies the prefix for control commands like `@set` (default `@`). **Enable parameters in DDL and`$$..$$` blocks** | Permits the use of parameters within DDL statements and `$$..$$` code blocks. **Enable variables** | Activates variable substitution within SQL scripts. #### Common¶ Setting | Description ---|--- **Invalidate connection before execute** | Reconnect the session before each execution to clear a stale or dropped connection. **Beep after query finish** | Play a short system sound when the current execution finishes. **Refresh active schema after SQL execution** | Read active schema contents after each execution. If a query or procedure changes the active schema, the schema objects are updated in the UI. This option doesn’t work if additional metadata read is disabled. **Clear output log before execution** | Clear output log before each query/script execution. Suggested if queries produce a very large output log. **SQL statement timeout (sec)** | Maximum execution time for a single query in seconds. `0` means no limit. DBeaver passes this value to the JDBC driver as a query timeout. #### Scripts¶ Setting | Description ---|--- **Commit type** | Chooses when to commit during script execution: \- **At script end** \- run everything in one transaction, commit at the end. \- **After each query (autocommit)** \- commit after every statement. \- **After each N-th query** \- commit every N statements; when this option is selected, an input field appears to set **N**. \- **No commit** \- leave the transaction open, so you decide when to commit or roll back. **Error handling** | What to do on the first error: \- **Stop + rollback** \- stop and roll back the current transaction. \- **Stop + commit** \- stop and keep successful work. \- **Ignore** \- continue running the rest of the script. **Fetch query results** | For `SELECT` queries fetch and show results in a separate tab. **Maximize editor on script execute** | Maximize the editor when you run the script. **Show statistics** | Defines whether to show a special tab with statistics about query execution: \- **Only when no data** \- **For multiple queries with results** \- statistics will be shown even if `SELECT` statements returned data. If no data is returned, statistics are displayed anyway. \- **Always** **Set selection to Statistics tab** | Set selection to the tab containing statistics about query execution. **Close included script tab after execution** | Close the editor after a script included with `@include` command has executed. #### Delimiters¶ Setting | Description ---|--- **Statements delimiter** | Character that separates SQL statements. Default: `;`. **Ignore native delimiter** | Ignore native delimiter and use the default delimiter value from **Statements delimiter** above. **Blank line is statement delimiter** | Use blank line as delimiter when parsing statements. Options: \- **Always** \- any blank line is treated as a delimiter. \- **Never** \- blank lines are not treated as delimiters. \- **Smart** \- the editor checks the following lines to decide whether a blank line should act as a delimiter. **Remove trailing query delimiter** | Remove trailing query delimiter when sending statements to the server. ### Variables¶ Define the custom variables with the predefined command or add in the [Variables panel](../Variables-panel/). You can create a variable by using the `@set` command followed by the variable name and its value. For instance: @set actor_name = Mark Once defined, you can include variables in your SQL queries. Use the `${varname}` or `:varname` syntax to insert the value of a variable into the script. For example: SELECT * FROM public.actor WHERE first_name = '${actor_name}'; Info For advanced SQL execution, DBeaver extends functionality with context variables that come from: * **CLI** : Command-line interface variables, which offer a hands-off approach for setting up environments. See the [Command-line guide](../Command-Line/#dbeaver-control) for usage details. * **Auth properties** : Authentication-related variables that enhance security for credential handling, detailed in the [Authentication properties documentation](../Admin-Variables/). ### Dynamic parameters binding¶ You can define parameters using the `:parameter` syntax, turning parts of the query into placeholders for values input at execution. For instance: SELECT :first_parameter FROM public.actor WHERE first_name = :second_parameter; Upon every execution of the parameterized query, DBeaver brings up the **Bind parameter(s)** window. ![](../images/ug/Bind-parameters-dialog.png) Field | Description ---|--- **Value** | Fill in values for each parameter to ensure correct query execution. **Hide parameters set in script** | If checked, parameters that you have already given values with the `@set` command will not show up. Tip To simplify the process, consider using variables for predefined values before running the script. ## Miscellaneous¶ To open the definition of the database object currently in focus (under cursor) in a viewer/editor, press `F4`. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Formatting/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](./) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) 1. [DBeaver](/docs/dbeaver) 2. [SQL Editor](/docs/dbeaver/SQL-Editor) 3. Query development and assistance # SQL query formatter To format an SQL text, select it and press `Ctrl+Shift+F` or right-click the selected text and click **Format - > Format SQL** on the context menu. ![](../images/ug/Format-SQL.png) To format a script to upper or lower case, highlight the SQL text, then right- click it and click **Format - > To Upper Case / To Lower Case**, respectively, on the context menu. ![](../images/ug/Toggle-Upper-Lower-Case.png) To comment out an SQL line, press `Ctrl+/` or right-click the line and click **Format - > Toggle Line Comment** on the context menu. To uncomment a commented line, manually remove the commenting syntax, or press the same button combination, or right-click the line and click the same item on the context menu. ![](../images/ug/Comment-line.png) To comment out a block of text, select the text, then press `Ctrl+Shift+/` or right-click it and click **Format - > Toggle Block Comment** on the context menu. To uncomment a commented block of text, you can either manually remove the commenting syntax or select the same block of text, right-click it and click the same item on the context menu or press the same button combination. ![](../images/ug/Comment-block.png) To trim spaces (leading and trailing) SQL text right-click the selected text or end of string and click **Format - > Trim spaces** on the context menu. You can choose a part of the text ![](../images/ug/Format-Trim-Spaces-Highlighted-String.png) or put the cursor at the end of the row you want to trim ![](../images/ug/Format-Trim-Spaces-Cursor-On-End.png) You will get the following result: ![](../images/ug/Format-Trim-Spaces-Result-One.png) Or you can choose a part of the text from many lines ![](../images/ug/Format-Trim-Spaces-All-Text-Highlighted.png) Then each of the selected rows will trim, and the final result will be like this: ![](../images/ug/Format-Trim-Spaces-Result-Two.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Generation/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * SQL generation [ SQL generation ](./) Table of contents * Generate SQL Scripts * From Data Editor * From Database Navigator * Additional Settings * Read Data in SQL Console * Save Your Scripts * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Generate SQL Scripts * From Data Editor * From Database Navigator * Additional Settings * Read Data in SQL Console * Save Your Scripts 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # SQL generation DBeaver provides the functionality to automatically generate SQL scripts, streamlining your SQL scripting process. This feature is accessible from two main areas within the application: the [Data Editor](../Data-Editor/) and the [Database Navigator](../Database-Navigator/). ## Generate SQL Scripts¶ ### From Data Editor¶ You can automatically generate SQL statements based on the selected database object in the Data Editor. To do this: 1. Right-click on the selected database object. 2. Click **Generate SQL**. 3. Choose one of the SQL commands from the context menu that appears. 4. The generated SQL statement will appear in a new window for you to review and copy. ![](../images/ug/Generate-SQL-from-Data-Editor.png) ### From Database Navigator¶ You can also generate SQL scripts directly from the Database Navigator. To do this: 1. Right-click on a database object in the Database Navigator. 2. Navigate to **Generate SQL**. 3. Choose the type of SQL statement you want to generate. 4. The generated SQL statement will appear in a new window for you to review and copy. ![](../images/ug/Generate-SQL-from-Database-Navigator.png) ### Additional Settings¶ In the opened window, you have options to further customize your generated SQL script. Option | Description ---|--- **Use the fully qualified names** | Includes `[schema name].[table name]` in table references. **Compact SQL** | Condenses SQL script into a single line. **Separate foreign keys** | Isolates foreign key definitions in the script. **Exclude auto-generated columns** | Omits automatically generated columns from the script. **Use custom data/time format** | Customizes date and time formats in the script. **Show comments** | Adds comments to the script for readability. **Show permissions** | Includes permission settings in the script. **Show full DDL** | Adds a comprehensive **Data Definition Language** section to the script. **Show partitions DDL** | Incorporates partitioning information into the DDL section of the script. **Use explicit type cast** | Adds explicit type casting for SQL values in the script. **Add`CAST` to parameters definition** | Adds explicit data type conversion to parameter definitions in the script. **Note** : The availability of these settings may vary depending on the database you are using. ## Read Data in SQL Console¶ DBeaver streamlines your database navigation tasks with its capability to automatically generate and execute `SELECT` statements. This functionality is especially useful when you are working in the [Database Navigator](../Database-Navigator/). ![](../images/ug/Read-data-in-SQL-Console.png) To read data in SQL Console: 1. Navigate to the **Database Navigator** and identify the database object you want to read. 2. Right-click on the chosen database object. 3. Select **Read data in SQL console**. 4. A **SQL console** opens, executing the query and fetching all relevant rows. ### Save Your Scripts¶ DBeaver offers two methods for saving the SQL queries you've executed: * **Save As** : Accessible through the **SQL console** 's context menu, this option allows you to save the SQL query after specifying a file name. * **Save as Script** : Also found in the **SQL console** 's context menu, this function saves the query immediately as a numbered script, without prompting you for a file name. Tip Pressing `Ctrl+S` will transform the **SQL console** into a **SQL editor** , enabling more extensive modifications. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Plus-Script-Execution/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * SQL Plus script execution [ SQL Plus script execution ](./) Table of contents * Execute scripts * Use commands * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Execute scripts * Use commands 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # SQL Plus script execution For Oracle database users, DBeaver supports script execution through Oracle **SQL Plus**. To use this feature: * Ensure **SQL Plus** is installed on your system and properly configured to connect to your Oracle database. * Configure your [Oracle](../Oracle/) database connection. Info For more details on configuring **SQL Plus** , see [official Oracle documentation](https://docs.oracle.com/database/121/SQPUG/pt_one.htm#sthref33). * Ensure your local client configuration is correct to avoid connection issues. For more information on a Local client, see [Local client configuration](../Local-Client-Configuration/). ## Execute scripts¶ 1. In the [Database Navigator](../Database-Navigator/), select a schema within your Oracle database. 2. Right-click to open the context menu and choose **Tools - > Execute in SQL Plus**. 3. A wizard opens, prompting you to select the path to your script. 4. After selecting your script, click **Start** and wait for the script execution to complete. ## Use commands¶ DBeaver supports several [commands](../Client-Side-Scripting/#oracle) for Oracle compatibility. Example ACCEPT salary NUMBER FORMAT '000.0' DEFAULT '000.99' PROMPT 'Enter weekly salary ' Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Templates/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * SQL templates [ SQL templates ](./) Table of contents * Standard Eclipse templates * DBeaver specific templates * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Standard Eclipse templates * DBeaver specific templates 1. [DBeaver](/docs/dbeaver) 2. [SQL Editor](/docs/dbeaver/SQL-Editor) 3. Query development and assistance # SQL templates Templates let you quickly insert commonly used SQL statements into an SQL script. To view available templates, press `Ctrl+Alt+SPACE` (`⌃+⌥+SPACE` on macOS) or right-click within the script panel and select **SQL Template** from the context menu. A list of available templates will appear: ![](../images/ug/Available-templates.png) To apply a template in the SQL Editor, in the script pane: * Type the template name and press `Tab`. * Right-click where you want to insert a template, select **SQL Template** from the context menu, and double-click the template name from the list. The SQL statement will be inserted into the script. To edit, add, or remove templates, click the Configure icon in the bottom toolbar, then go to **Preferences - > SQL Editor -> Templates**. Tip For more information on managing templates, see [Eclipse documentation](http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Fconcepts%2Fconcept- editor-templates.htm). ## Standard Eclipse templates¶ Variable | Description ---|--- `${cursor}` | Specifies the cursor position when the template edit mode is left. This is useful when the cursor should jump to a different place than to the end of the template upon leaving the template edit mode. `${year}` | Takes the current year value. `${date}` | Takes the current date value. `${time}` | Takes the current time value. `${dollar}` | Takes the dollar sign $. Alternatively, two dollar signs can be used: $$. `${user}` | Takes the user name. `${word_selection}` | Takes the content of the current text selection. `${line_selection}` | Takes content of all currently selected lines. ## DBeaver specific templates¶ Variable | Description ---|--- `${schema}` | Takes the current schema name. `${catalog}` | Takes the catalog name. `${table}` | Takes the current table name (from the active catalog/schema). `${column}` | Takes the column name (from the current table). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SQL-Terminal/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * SQL terminal [ SQL terminal ](./) Table of contents * SQL Terminal * Context menu * Preferences * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * SQL Terminal * Context menu * Preferences 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # SQL terminal SQL Terminal allows you to display the results of executed SQL queries in a text-based format within the [SQL Editor](../SQL-Editor/). ## SQL Terminal¶ To open the **SQL Terminal** , press the corresponding button ![](../images/sql_terminal/SQL-Terminal-button.png) on the **SQL Editor** toolbar. Note The toolbar is customizable. See [Toolbar customization](../Toolbar- Customization/#sql-editor-toolbar-customization) article. In the **SQL Terminal** , you can view the result set, including data, errors, and statistical information along with the text of the executed query. ![](../images/sql_terminal/execution.png) ### Context menu¶ A context menu is available by right-clicking within the **SQL Terminal** area. This menu provides quick access to various commands. ![](../images/sql_terminal/context-menu.png) Command | Description ---|--- **Copy** | Copies the selected text to the clipboard. **Select All** | Selects all text in the **SQL Terminal**. **Toggle Word Wrap** | Toggles wrapping of long lines of text. **Find/Replace...** | Opens the find/replace dialog. **Clear** | Clears the contents of the **SQL Terminal**. ## Preferences¶ To configure SQL Terminal settings, go to **Window - > Preferences -> Editors -> SQL Editor -> SQL Terminal**. ![](../images/sql_terminal/SQL-Terminal-preferences.png) Setting | Description ---|--- **Use SQL Terminal by default** | **SQL Terminal** will open for every new script. **Show query text** | Displays the text of the executed query in the terminal. **Show server output** | Shows output messages from the server in the terminal. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SSH-Configuration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * SSH configuration [ SSH configuration ](./) Table of contents * Configure SSH tunnels * Configuring Jump servers * Practical use * Advanced settings * Port Forwarding * SSH and URL based connections * SSH shared tunnels * SSH tunnel sharing criteria * Configuring Cloud SSH Tunnels * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configure SSH tunnels * Configuring Jump servers * Practical use * Advanced settings * Port Forwarding * SSH and URL based connections * SSH shared tunnels * SSH tunnel sharing criteria * Configuring Cloud SSH Tunnels 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. Connection network options # SSH configuration Sometimes the database cannot be accessed directly, in such cases you can use the SSH tunnel. The SSH or Secure Shell is a network communication protocol that allows two computers to communicate and encrypts the shared data. DBeaver supports the following SSH authentication methods: * Username/password * Public key authentication * Agent authentication Available agent authentication implementations: * [pageant](https://www.digitalocean.com/community/tutorials/how-to-use-pageant-to-streamline-ssh-key-authentication-with-putty) _(Windows only)_ * [ssh-agent](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) Note You have to run the agent first before connecting to the database in DBeaver. ## Configure SSH tunnels¶ To set up **SSH** , you need to configure the following settings: 1. Start [creating a new connection](../Create-Connection/). 2. Click on the plus (![](../images/plus-button.png)) button and select **SSH**. ![](../images/ug/network/ssh/ssh-configuration-select-ssh.png) 3. After selecting, an **SSH** tab will appear in the menu at the top. ![](../images/ug/network/ssh/ssh-configuration.png) 4. In the **SSH** tab, enter the necessary configuration details: Field | Description ---|--- **Host/IP** | Remote server address. Use IP or hostname (e.g. `192.168.0.10`, `myhost`). **Port** | SSH port (default is `22`). **User name** | Your SSH username. **Authentication method** | Choose how to authenticate: `Password`, `Public Key`, or `Agent`. **Password** (optional) | Enter your SSH password. **Save credentials** (optional) | Enable this to store credentials securely. 5. After configuring settings, click on **Test tunnel configuration** button to test whether all parameters are valid. 6. Set the host in **Main** tab to `localhost`. This tells the database connection to use the remote server accessed via SSH, but tunnel I/O through your local machine. Tip Use [network profiles](../Network-profiles/) to save and reuse your settings across multiple connections. ### Configuring Jump servers¶ DBeaver allows the use of Jump servers, also known as Gateway hosts. This feature is essential when the direct access to a target machine is not possible from your local machine, and a gateway server is required for connection. ![](../images/ug/network/ssh/jump-server-configuration.png) To add a jump server: 1. Ensure **Use SSH Tunnel** is checked. 2. Expand the **Jump servers** group. 3. Specify your target in the **Settings** section. 4. Click on the **Create new jump host** button ![](../images/ug/network/ssh/Create-new-jump-host-button.png) to add your first jump server configuration. Repeat step 3 for each additional jump host you need to add, configuring each one within the **Settings** section. #### Practical use¶ Imagine you have the following situation: your database is located on remote machine with IP address `100.100.100.100` and which is accessible through SSH. You cannot access this IP directly from your machine because of your network settings or firewall, but you can access other machines with the IP address `200.200.200.200` through SSH and which **is able** to access the desired remote machine. You will need to specify `100.100.100.100` as a host in regular SSH configuration and `200.200.200.200` as a host in a gateway configuration to achieve such a "connection order": `localhost` → `200.200.200.200` → `100.100.100.100`. ### Advanced settings¶ ![](../images/ug/network/ssh/advanced-options.png) Setting | Description ---|--- Implementation | Specifies the SSH library used for the connection. Bypass host verification | If checked, disables verification of the server's identity by not checking the remote host's fingerprint, which may lead to security risks such as Man-In-The-Middle attacks. Share this tunnel with other connections | If checked, allows multiple connections to share the same SSH tunnel. This can improve connection speed and reduce server load. Sessions remain open until all connections using the tunnel are closed, even if the initiating connection is terminated. Keep-Alive interval (ms) | Sets the interval in milliseconds for sending a keep-alive packet to keep the connection active. A value of 0 disables keep-alive packets. Tunnel connect timeout (ms) | Sets the maximum time in milliseconds to establish a tunnel connection before timing out. #### Port Forwarding¶ Port forwarding is used to expose a socket sitting on a remote port to your local port, allowing you to communicate with it. After the SSH connection to the remote machine is established, you need to connect to the database on that machine. You must pass the port on which the database is listening from that remote machine to your local machine. This is when port forwarding becomes handy. By default, it randomly chooses the local port and forwards it to the destination port set in **Connection settings - > Main** It is not usually required to change this configuration, but it can be useful, for example, when you want to use a particular local port. #### SSH and URL based connections¶ By default DBeaver opens random local port and forwards it to a target database port. It then implicitly replaces port configured in the connection with this random port. So technically DBeaver will connect to something like `localhost:45678` (random port on localhost) instead of `database.server.domain:5432` (default PostgreSQL server port). But if you use URL instead of manual connection configuration then you connect to `jdbc:postgresql://database.server.domain/postgresql`. DBeaver cannot replace port number automatically because you can use any type of sophisticated URLs. DBeaver just don't know how to change this URL. If you use URL connection then you must configure port forwarding manually. In the Advanced Settings set both Local Port and Remote Port to 5432 (database server port, 5432 is the default value for PostgreSQL). It will work in most cases. But it will fail if you have PostgreSQL server on your local machine because port 5432 is already occupied. In this case you can use any random port number for Loca Port (e.g. 15432). Use the same 5432 for Remote Port because it is real port number for remote PostgreSQL server. ### SSH shared tunnels¶ By default, DBeaver shares SSH tunnels across connections when the same SSH settings are used. This is particularly useful when connecting to several databases on the same remote server, as it avoids the need to establish a separate SSH tunnel for each connection. To view the active SSH tunnels and the databases utilizing a shared tunnel, use the **SSH tunnel explorer**. This feature provides a comprehensive overview of your SSH tunnel usage, including detailed information on each tunnel and the databases it serves. Here is how to access **SSH tunnel explorer** : 1. Navigate to **Window - > Show View -> Other...** 2. In the window that appears, expand the **Database** category. 3. Select **SSH tunnel explorer** and click **Open**. In the **SSH tunnel explorer** view, you will find information about each active tunnel. This includes: Field | Description ---|--- **Destination** | The remote server to which the tunnel connects. **Used by** | A list of databases that are currently using the tunnel. **Port Forwards** | The local and remote ports involved in the tunneling process. #### SSH tunnel sharing criteria¶ DBeaver shares SSH tunnels across connections if SSH settings are identical. The application compares the following parameters to determine if the SSH settings match: * **Hostname** : The address of the SSH server. * **Host port** : The port number used for the SSH connection. * **Username** : The username required for SSH authentication. Depending on the authentication method selected, DBeaver also compares: * For password authentication: * **Password** : The SSH account password. * For public key authentication: * **Private Key** : The file path to the SSH private key. * **Passphrase** : The passphrase for decrypting the private key, if set. * For agent authentication: * **Agents** : DBeaver treats all agent authentication configurations as identical, ignoring specific agent settings and focusing only on the method's selection. ## Configuring Cloud SSH Tunnels¶ * To configure Cloud SSH Tunnels, start by navigating to the **Cloud Explorer** button ![](../images/ug/cloud-explorer/cloud-explorer-button.png) in the Toolbar. * Select **Edit** button ![](../images/ug/cloud-explorer/edit-configuration-button.png) for an existing connection or **New** button ![](../images/plus-button.png) to create a new connection. * In the opened window, go to the **Tunnels** tab. ![](../images/ug/cloud-explorer/ssh-cloud-tunnel-configuration.png) * This tab allows you to set up SSH tunnels specifically for cloud connections. * The configuration here is similar to the standard SSH setup, but it's integrated within your cloud service provider's settings. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/SSL-Configuration/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * SSL configuration [ SSL configuration ](./) Table of contents * Setting up SSL configuration * Setting up SSL configuration via Driver properties * Troubleshooting SSL issues * Import custom certificates * Oracle SSL configuration * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Setting up SSL configuration * Setting up SSL configuration via Driver properties * Troubleshooting SSL issues * Import custom certificates * Oracle SSL configuration 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. [Network configuration](/docs/dbeaver/Network-configuration) 4. [Connection network options](/docs/dbeaver/SSH-Configuration) 5. SSL # SSL configuration DBeaver supports the ability to establish connections using Secure Socket Layer (SSL), a protocol for creating authenticated and encrypted links between networked computers. Note SSL parameters are optional and should only be specified if required by your server configuration. ## Setting up SSL configuration¶ To set up **SSH** , you need to configure the following settings: 1. Start [creating a new connection](../Create-Connection/). 2. Click on the plus (![](../images/plus-button.png)) button and select **SSL**. ![](../images/ug/network/ssl/ssl-configuration-select-ssl.png) 3. After selecting, an **SSL** tab will appear in the menu at the top. ![](../images/ug/network/ssl/connection-ssl.png) 4. In the **SSL** tab, enter the necessary configuration details: Parameter | Description ---|--- **CA Certificate** | Path to the Certificate Authority (CA) certificate. **Client Certificate** | Path to the client's public key certificate. **Client Private Key** | Path to the client's private key. **Keystore** | Path to the keystore file. **Keystore Password** | Password for the keystore. **Certificate hostname** | Expected hostname in the certificate. **SSL Mode** | Desired security level for SSL. **SSL Factory** | Provide SSLSocketFactory factory class name. **Cipher suites (optional)** | Specific cipher suites to use. **Skip host name validation** | Whether to bypass hostname validation. **Use self signed certificate (non-secure)** | Acceptance of self-signed certificates. **Force TLS 1.2** | Enforce using TLS version 1.2. **Verify server certificate** | Ensures the server certificate is valid. **Allow public key retrieval** | Allows the retrieval of the server's public key. Note The availability of these parameters can vary depending on the database. Check the SSL tab for your database within the **Connection settings** for any specific options. 5. After configuring settings, click on **Test Configuration** button to test whether all parameters are valid. Tip Use [network profiles](../Network-profiles/) to save and reuse your settings across multiple connections. ## Setting up SSL configuration via Driver properties¶ For some databases, an alternative method to configure SSL settings is available through the **Driver properties** tab. This approach allows access to additional or driver-specific SSL options that may not be present in the main SSL tab: 1. Select the **Driver properties** tab within the **Connection settings**. ![](../images/ug/network/ssl/ssl-driver-properties-configuration.png) 2. Look for properties prefixed with `ssl`, such as `sslResponseTime`, `sslfactoryarg`, `sslhostnameverifier`, etc. Configure the necessary properties according to your database and server requirements. 3. If all other necessary connection settings are configured, complete the setup by clicking **Finish** , or test the configuration by clicking **Test Connection** to ensure that SSL is functioning correctly. ## Troubleshooting SSL issues¶ If you encounter a `Pkix path building failed` error, it may be due to incorrect SSL configurations. A common resolution is to consider ignoring host name validation, an option available for some databases in the **SSL** tab of the Connection settings, which can help bypass common SSL errors. ## Import custom certificates¶ Learn how to import custom root and certificate authority (CA) certificates into DBeaver. See [Import custom certificates](../Import-SSL-Certificates/) for detailed instructions. ## Oracle SSL configuration¶ Learn how to set up SSL connections for Oracle databases, including wallet creation and configuration steps. See [SSL for Oracle](../SSL-Configuration- Oracle/) for the full guide. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Sample-Database/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * Sample database [ Sample database ](./) Table of contents * Simple database * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Simple database 1. [DBeaver](/docs/dbeaver) 2. Tutorials # Sample database If you want to test **DBeaver** features, you can create a demo database. There is a specialized database that can be created. You can create a sample _SQLite_ database at the first launch. The database can be added at any time by the following sequence. Chinook is used as a reference database ## Simple database¶ Navigate to **Help - > Create Sample Base** to create a simple database. ![](../images/help_menu.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Schema-compare/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * Schema compare [ Schema compare ](./) Table of contents * Databases supporting schema comparison * How it works * What is possible to compare * How to use schema compare * Step 1. Select two entities to compare * Step 2. Check the selected entities * Step 3. Specify compare settings * Step 4. Look at the comparison results and save the report * Step 4. Comparison results * Quote objects names in the report * Compare logs * Liquibase Changelog generation * Save operation as a task * Using schema compare with Liquibase PRO key * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Databases supporting schema comparison * How it works * What is possible to compare * How to use schema compare * Step 1. Select two entities to compare * Step 2. Check the selected entities * Step 3. Specify compare settings * Step 4. Look at the comparison results and save the report * Step 4. Comparison results * Quote objects names in the report * Compare logs * Liquibase Changelog generation * Save operation as a task * Using schema compare with Liquibase PRO key 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Schema compare # Schema compare Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. ## Databases supporting schema comparison¶ \----------------------- | \----------------------- ---|--- Cockroach | Oracle Databricks | PostgreSQL DB2 | Redshift Derby | SAP HANA EnterpriseDB | Snowflake Firebird | SQLite Greenplum | SQLServer Informix | Teradata MySQL/MariaDB | Vertica Netezza | YugabyteDB DB2i | ## How it works¶ You can compare two schema/database structures and generate a report in the following formats: * DDL script (series of create/alter/drop statements) * Diff diagram (sort of [Diagram](../ER-Diagrams/)) * Liquibase changelog * Liquibase change report (JSON, YAML, or plaintext) ## What is possible to compare¶ In most cases, you can compare **schemas, databases, or tables**. However, some databases (such as SQLite and Firebird) do not have catalogs and schemes that can be compared. In this case (and only for these databases), it is possible to compare the entire **datasources**. Usually, you can compare the following database objects: **columns, primary keys, foreign keys, indexes** , and so on (it depends on your database). If you want to compare more objects, such as **check constraints, procedures, functions, triggers** , you need to enable Liquibase PRO. ## How to use schema compare¶ ### Step 1. Select two entities to compare¶ 1. Select the two objects (schemas, databases, or tables) you want to compare in the **Database Navigator**. Tip You can start the compare through AI by sending a short request in AI chat. See [Data transfer actions](../Data-Transfer-Actions/) for supported commands. 2. Open the context menu. 3. Open the sub-menu **Compare/Migrate** and click the **Compare/Migrate Schema**. You'll see the comparison window. ![](../images/ug/tools/schema_compare/schema_compare_navigator.png) ### Step 2. Check the selected entities¶ Re-validate that you have chosen the correct objects to compare. You can change target and source containers by clicking the **Swap sources**. ![](../images/ug/tools/schema_compare/schema_compare_settings.png) Note You must select only those schemas/directories/containers that contain tables: * Schemas – if the database supports schemas. * Databases – if the database supports catalogs and does not support schemas. ![](../images/ug/tools/schema_compare/schema_compare_container_error.png) * Datasources – if there is no support for schemas or catalogs. ![](../images/ug/tools/schema_compare/schema_compare_schemaless.png) If everything is correct, click **Next**. You'll see the comparison settings. ### Step 3. Specify compare settings¶ 1. If you want to export the comparison result in a file, select **Export result to the file** option, then specify the folder and file name. You can use variables in the file name. Click on the field with a file name to see a list of available variables. 2. Select the report format in the **Report Engine** field. ![](../images/ug/tools/schema_compare/schema_compare_change_engine.png) 3. You can simply exclude specific types of objects from comparison. For example, it is possible not to show sequences, views, or external keys in the final comparison result. 4. You can also specify which changes should be processed: create, drop, or alter. By default, all kinds of changes are enabled. If you do not want to compare objects with equal names but in different cases (like "test" and "TesT"), enable the **Case insensitive compare**. (Note: This settings section is unavailable for the generation changelog process.) ![](../images/ug/tools/schema_compare/schema_compare_settings_types.png) Tip You can export the results of a schema compare operation to a remote file system via [Cloud Storage](../Cloud-Storage/) using the **Browser remote file system** button ![](../images/dt/Browser-remote-file-system-button.png). ### Step 4. Look at the comparison results and save the report¶ Click **Proceed** to generate a diff report. ### Step 4. Comparison results¶ By default, DDL diff is generated. It contains a series of creating, altering, and/or dropping statements that will modify the schema on the right side. Thus, it will make it identical to the schema on the left side. ![](../images/ug/tools/schema_compare/schema_compare_result_ddl.png) This comparison interface provides a suite of options to manage your results effectively: Button/Option | Description ---|--- **All** | Enables all changes in the changes tree on the left side of the diff page. **None** | Disables all changes in the changes tree on the left side of the diff page. **Refresh Report** | Updates the comparison report to reflect any changes made to the selection or schema. **Show log** | For detailed information about logs, refer to the section Compare logs. **Export** | Exports the current diff report to a `.txt` file. **Save** | Saves the current state of the report. **Copy** | Copies the generated SQL or report text to the clipboard for easy pasting elsewhere. **Open in Editor** | Opens the current diff report in the SQL Editor for further editing or review. **Migrate** | Executes the generated SQL statements on the target database, applying all selected changes. ## Quote objects names in the report¶ For the objects in the report to be dressed in quotation marks, select the `Quote all objects names` option in Preferences. ![](../images/ug/tools/schema_compare/schema_compare_preferences.png) ## Compare logs¶ To get acquainted with the comparison logs, you first specify the logging level on the **Preferences- > Editors-> Schema Compare** preference page. Specify one of the logging levels and click on **Apply**. By default, the logging level is the OFF level. To get complete information, you can choose the DEBUG level. ![](../images/ug/tools/schema_compare/schema_compare_log_levels.png) After comparing operations, click the `Show log` button. A log will be open in the Editor, and the content of this log will depend on the logging level you choose in the settings. Log level changes from preferences will not be applied to the comparison wizard if it is already open in another window. Close and open the schema compare wizard in this case. ![](../images/ug/tools/schema_compare/schema_compare_show_logs.png) ## Liquibase Changelog generation¶ Suppose you want to create a report about the objects in your table container (similar to the metadata dump operation). In that case, you can select in the navigator tree on your container **Compare/Migrate** -> **Liquibase changelog** command. ![](../images/ug/tools/schema_compare/schema_changelog_input.png) One or several table containers can be chosen. The report will contain creation statements of tables/views/keys/sequences - metadata from the table containers. But without data from tables/views. You can use this report in the future to restore the structure of your database. ![](../images/ug/tools/schema_compare/schema_changelog_result.png) ## Save operation as a task¶ If you plan to constantly use the comparison or generation changelog/schema comparison, exporting the result as a file, you can save this as a task. The task can be completed anytime and put on the [schedule](../Task-Scheduler/). ![](../images/ug/tools/schema_compare/schema_compare_as_task.png) Also, generating a changelog or schema comparison can be part of the [composite task](../Composite-Tasks/). For example, if you keep the log as a script with a certain name, then the implementation of this script can be set by the second operation of the composite task. ![](../images/ug/tools/schema_compare/schema_compare_as_composite_task.png) ## Using schema compare with Liquibase PRO key¶ With a Liquibase Pro key, you can unlock advanced schema comparison features in DBeaver, including support for functions, procedures, and extended [Pro objects](../Using-Liquibase-in-DBeaver/#object-types-being-compared-by- liquibasepro). Info For steps to set up Liquibase, see the [Liquibase setup guide](../Using- Liquibase-in-DBeaver/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Search-Tool/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * Search [ Search ](./) Table of contents * Search View * Search History * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Search View * Search History 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Search # Search To use search, click the Search button on the main toolbar: ![](../images/ug/Search-menu.png) Please see the dedicated articles for information about searching for different types. This article describes common features of the three search types. ## Search View¶ Search results for any of the search types appear in a separate Search view. The following image shows the Search view for the database full text search: ![](../images/ug/Search-results-view.png) The view contains a toolbar that provides common tools for all types of search as well as specific tools for the File Search type. The following are common tools: Button | Name | Description ---|---|--- ![](../images/ug/Run-Current-Search-button.png) | **Run the Current Search Again** | Refreshes the search results ![](../images/ug/Cancel-Search-grey.png)/![](../images/ug/Cancel-Search-active.png) | **Cancel Current Search** | \- Active state (red) indicates that the search is still in progress and appears if the search takes some time to complete. Clicking the button in this state stops the current search. \- Inactive state (grey) indicates that the search is complete. The button in this state is non-actionable. ![](../images/ug/Previous-Searches-button.png) | **Show Previous Searches** | \- Clicking the button itself opens the Previous Searches window. \- Clicking the arrow next to the button opens a dropdown menu. See the _Search History_ section further in this article. ![](../images/ug/Pin-Search-View-button.png) | **Pin the Search View** | Ties the current search results to the Search view. If you click this button, the current results stay in the view while the results of the next search appear in a new Search view. Otherwise, every new search replaces the previous results with new results. For information about specific tools of File search, see the [File Search](../File-Search/) article. If the search is short, the results appear almost instantly. But if it takes some time, the Search view indicates the progress in the following ways: * The **Cancel Current Search** button in the toolbar has the Active state (![](../images/ug/Cancel-Search-active.png)) * The progress bar appears in the bottom-right corner of the view indicating the process: ![](../images/ug/Search-progress-field.png) * The button to show the search progress in a separate view (![](../images/ug/Show-progress-button.png)) appears in the bottom-right corner of the view next to the search progress bar. Clicking the button opens the Background Tasks view: ![](../images/ug/Background-tasks-view.png) ## Search History¶ DBeaver stores the history of search queries made during the current session. You can reopen the Search view with results of a previous search query. You can also remove individual queries and clear the history. To manage the search history, use the **Show Previous Searches** button in the toolbar (![](../images/ug/Previous-Searches-button.png)). To open the results of a previous search query, do one of the following: * Click the arrow next to the **Show Previous Searches** button in the toolbar and then click the query in the dropdown list: ![](../images/ug/Search-history-menu.png) * Click the **Show Previous Searches** button itself or the arrow next to it and then **History** on the dropdown menu to open the Previous Searches window. Then, in the window, click the query and then either click **Open** to open it in the active Search view or click **Open in New** to open it in a new view: ![](../images/ug/Previous-Searches-window.png) To remove one or more of the previous search queries: 1. Click the **Show Previous Searches** button in the toolbar or click the arrow next to it and then **History** on the dropdown menu. The Previous Searches window opens. 2. Click the query to remove or select several of them by clicking and simultaneously holding the `Ctrl` key. 3. Click **Remove**. To clear the history by removing all previous queries, click the arrow next to the **Show Previous Searches** button on the toolbar and then click **Clear History** on the dropdown menu. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Secret-Providers/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * Secret Management [ Secret Management ](./) Table of contents * Configuring secret provider * Add a secret provider * AWS secrets * Vault secrets * CyberArk * Authentication types * Password authentication * Token authentication * OAuth2 configuration * Configuring JWT authentication * Creating a connection * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Configuring secret provider * Add a secret provider * AWS secrets * Vault secrets * CyberArk * Authentication types * Password authentication * Token authentication * OAuth2 configuration * Configuring JWT authentication * Creating a connection 1. [DBeaver](/docs/dbeaver) 2. Security # Secret Management Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. DBeaver supports external secret managers to securely store and access credentials. Secret manager | Description ---|--- [**AWS Secrets Manager**](https://docs.aws.amazon.com/prescriptive-guidance/latest/modernization-net-applications-security/configure-asm.html) | Managed service from AWS for storing and retrieving secrets securely. Requires IAM permissions. [**HashiCorp Vault**](https://developer.hashicorp.com/vault/docs) | Open-source tool for managing secrets and protecting sensitive data. Supports fine-grained access control. [**CyberArk**](https://www.cyberark.com/) | Enterprise-grade security platform designed for managing privileged access and secrets. Note AWS Secrets is available for [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. ## Configuring secret provider¶ Before configuring a secret provider in DBeaver, ensure that: * secret provider is set up * You have the necessary access permissions ### Add a secret provider¶ 1. Open **Window - > Preferences -> Connections -> Secret providers** 2. Click **Add** button (![](../images/ug/tasks/add-task-button.png)) 3. Select a provider from the dropdown menu and click **OK** #### AWS secrets¶ 1. Fill in the required fields Field | Description ---|--- **Name** | Identifier for the secret configuration in DBeaver. **Cloud** | AWS configuration settings. For more details on configuring AWS Cloud in DBeaver, see [AWS Cloud Explorer](../AWS-Cloud-Explorer/). **Region** | AWS region where secrets are stored. 2. Click **OK** and **Apply and Close** to save the configuration #### Vault secrets¶ 1. Fill in the required fields Field | Description ---|--- **Provider** | Identifier for the secret configuration in DBeaver. **Name** | Unique name for this secret configuration. **Server** | URL of the Vault server used to retrieve secrets. **Authentication Type** | Select an authentication type (`Token`, `OAuth2`, `Password`). 2. Click **OK** and **Apply and Close** to save the configuration 3. [Import certificate](../Managing-Truststore-Settings/) if required #### CyberArk¶ 1. Fill in the required fields Field | Description ---|--- **Name** | Unique identifier for the secret configuration in DBeaver. **CyberArk Server URL** | URL of the Conjur OSS server (e.g., `https://conjur.example.com`). **Account** | Conjur tenant or organization account name (e.g., `myorg`). **Username** | Conjur user ID used for authentication. **API Key** | API key associated with the Conjur user for `authn` login. **Policy branch** | Path to the policy namespace where secrets are stored (e.g., `dev/app`). **Trust Certificate** (Optional) | Trust the CyberArk server’s SSL certificate without manual import. Enable this if you're using a self-signed certificate or connecting to a server whose certificate isn't trusted by default. Info For more details on authentication, policy structure, and SSL configuration, [CyberArk official documentation](https://docs.cyberark.com/portal/latest/en/docs.htm). 2. Click **OK** and **Apply and Close** to save the configuration 3. If required, [import the certificate](../Managing-Truststore-Settings/) ### Authentication types¶ #### Password authentication¶ Use a username and password to authenticate with the Vault server. Field | Description ---|--- **Username** | Username for authentication. **Password** | Password for authentication. #### Token authentication¶ Use an authentication token to access the Vault server. Field | Description ---|--- **Token** | Authentication token required to access the Vault server. #### OAuth2 configuration¶ When you select `OAuth2`, Vault uses a JWT (JSON Web Token) issued by the OAuth2 provider after the user logs in. Info Make sure your OAuth2 provider issues JWTs, and Vault is configured to validate them. The JWT must include the claims needed for Vault role mapping. Field | Description ---|--- **JWT provider ID** | Path where the JWT authentication method is enabled in Vault, for example, `auth/jwt/`. **JWT role** | Vault role name to match against a claim in the JWT token. **Auth URL** | OAuth2 Authorization endpoint (for example, `https://example.com/oauth2/authorize`). **Token URL** | OAuth2 Token endpoint (for example, `https://example.com/oauth2/token`). **Callback port** | Local port used to receive the OAuth2 authorization code. Default: `8000`. **Callback URL** | Full callback URL automatically generated using the port. Example: `http://localhost:8000/callback`. **Client ID** | OAuth2 client ID registered in your OAuth2 provider. **Client secret** | OAuth2 client secret registered in your OAuth2 provider. Info For details on configuring JWT authentication in Vault, see Configuring JWT authentication. #### Configuring JWT authentication¶ JWT authentication requires an external **Single Sign-On (SSO) provider** (e.g., Okta) because Vault does not generate JWTs internally. It works with any **OpenID Connect (OIDC) provider** that issues JWT tokens. This configuration happens on the Vault side and includes setting up authentication methods, validation rules, and role mappings. 1. **Enable the JWT authentication method in Vault** * enable JWT authentication * configure JWT validation settings, such as issuer and audience 2. **Create a role in Vault** * vault does not assign roles automatically * use the [API](https://developer.hashicorp.com/vault/api-docs/auth/jwt#create-update-role) to create a role * define policies and specify claims for user identification a. **Configure role assignment in the SSO provider** * ensure your SSO provider includes user roles in the JWT Info Use the SSO provider’s documentation to configure role claims. b. **Match the Vault Role Claim with a JWT claim** * the **Vault Role Claim** field should match the custom claim in the JWT token. * if it does not match, authentication will fail. Info See the [Vault documentation](https://developer.hashicorp.com/vault/docs/auth/jwt) for more details. ## Creating a connection¶ 1. Start [creating a connection](../Create-Connection/) 2. In the **Create Connection** wizard, go to the **Main** tab, choose secret provider configuration and enter the secret name in the **Secret parameters** field Info The secret name must match the name stored in your secret provider: -for **HashiCorp Vault** , use `secret/your_secret_name` \- for **AWS Secrets Manager** , use `your_secret_name` \- for **CyberArk Conjur** , use the full variable path, for example: `app/dev/db/password`. In Conjur, secret names reflect the full variable ID defined in your policy. For more details, see [Conjur variables](https://docs.cyberark.com/conjur-open-source/latest/en/Content/Policy/Variables.htm). 3. If the secret doesn’t include all required details (such as the `host` or `port`), enter them manually in the connection settings 4. Click the **Test Connection** button to verify your settings (if configured correctly, DBeaver will establish a connection using the **Secret Provider**) 5. Click **Finish** to save the connection Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Security-in-DBeaver-PRO/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * Security in DBeaver PRO [ Security in DBeaver PRO ](./) Table of contents * Master password * Secure Storage with Secret Providers * Changing database password * Password protection for Projects * Master password for all your Projects * Password for one project * Secure authentication * Kerberos support * SSO authentication * Predefined connections * Connections import * Read-only connections * Users roles and permissions * Configuring preferences * Roles in Team Edition * Centralized automatic updates * License management * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Master password * Secure Storage with Secret Providers * Changing database password * Password protection for Projects * Master password for all your Projects * Password for one project * Secure authentication * Kerberos support * SSO authentication * Predefined connections * Connections import * Read-only connections * Users roles and permissions * Configuring preferences * Roles in Team Edition * Centralized automatic updates * License management 1. [DBeaver](/docs/dbeaver) 2. Security # Security in DBeaver PRO Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. The level of security is one of the key questions for enterprises, and the DBeaver team pays a lot of attention to it. One of the best reasons to use PRO versions is to take advantage of its security tools and features, such as password protection, SSO authentication, teams and roles in Team Edition. This article briefly describes the most important security options available in DBeaver PRO. ## Master password¶ You can enhance security in DBeaver with the Master Password, which encrypts credentials and sensitive data using a secure storage system. This feature ensures that each user's credentials are individually protected by their own Master Password, tying the encryption specifically to their local environment. Info For more details, refer to the [Managing Master Password](../Managing-Master- Password/) article. ## Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials securely. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Changing database password¶ Users can change the current database password directly in DBeaver in the following databases: * Cockroach * Exasol * Greenplum * Netezza * Oracle * PostgreSQL * Redshift * Snowflake * SQL Server * Vertica. Info Oracle, PostgreSQL, and Netezza allow changing an expired password in DBeaver as well. * [How to change the user password](../Change-current-user-password/) ## Password protection for Projects¶ ### Master password for all your Projects¶ You can protect all [Projects](../Projects-View/) in your local workspace with a Master password. You can set this password and store it in DBeaver password provider or use a generated password from your local password provider (for instance, OS X Keystore Integration or Windows integration provider). [Learn more about the Master password for Projects](../Project- security/#master-password) ### Password for one project¶ You can specify a password for any project to protect all the project's configurations. [Learn more about project password](../Project-security/#project-password- management) ## Secure authentication¶ You can connect to databases using secure authentication via Kerberos or GCP, AWS, and Azure cloud services. ### Kerberos support¶ Kerberos is an authentication protocol, the default authentication technology used in Microsoft Windows. You can connect via Kerberos using keytab, kinit, or a password. Open the connection settings, choose one of the [supported databases](../Kerberos- Authentication/) and select Kerberos as the authentication method. [Learn more about authentication via Kerberos](../Kerberos-Authentication/) ### SSO authentication¶ Users can connect to all company services using only one login and password. This is possible if you use SSO - Single Sign-On authentication service. You do not need to manage, store, and transfer user credentials. When a user connects to the database, DBeaver opens a web browser with SSO authentication. DBeaver supports the following SSO authentication services: * [AWS SSO](../AWS-SSO/) * [GCP SSO](../GCP-SSO/) * [Azure](../Azure-Cloud-Explorer/) ## Predefined connections¶ ### Connections import¶ You can describe all available database connections in [configuration files](../Admin-Manage-Connections/#provide-predefined-connections) (in JSON format) or [import from CSV or XML](../Admin-Manage-Connections/#importing- connections-from-csv-or-xml) DBeaver. ### Read-only connections¶ If you want to restrict users from editing connection parameters, you can [protect them with passwords](../Admin-Manage-Connections/#secure-connections- from-editing). ## Users roles and permissions¶ ### Configuring preferences¶ You can customize users preferences before they run DBeaver. For example, you can set the default [simple mode](../Simple-and-Advanced-View/) for all connections (to show only schemas and tables and hide all system and service objects). [How to manage preferences](../Admin-Manage-Preferences/#default-navigator- view-for-new-connections) ### Roles in Team Edition¶ The best way to manage user access, restrictions, and permissions is to use [Team Edition](https://dbeaver.com/dbeaver-team-edition/). Team Edition allows you to create users and assign them appropriate roles with predefined capabilities. You can add Viewers and Editors to work with prepared data, Managers to prepare data for them, Developers to work with scripts and connections, and administrators to manage everything. ## Centralized automatic updates¶ If your team works on Microsoft Windows, you can organize DBeaver mass updates in silent mode, without user input, using the Windows Installer command line options. [Learn more about silent install](../Windows-Silent-Install/) ## License management¶ You can place the license file in the user's workspace or store it elsewhere, and specify the license path on the command line or in the DBeaver configuration file. * [Learn more about lisense management automation](../License-Administration/) * [How to specify license path in config](../License-Administration/#pass-the-license-file-via-command-line) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Security/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * Secure storage [ Secure storage ](./) Table of contents * Changing the password provider * Enabling database secure password storage * Advanced mode * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Changing the password provider * Enabling database secure password storage * Advanced mode 1. [DBeaver](/docs/dbeaver) 2. [Security](/docs/dbeaver/Security-in-DBeaver-PRO) 3. Password secure storage # Secure storage Note This feature is available in Community, [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. DBeaver has three password provider options: * **Master password (recommended)** – The most secure option for protecting sensitive data. [Learn more](../Managing-Master-Password/) ![](../images/commercial.png) * **Automation (console)** – Allows automated tasks to run without password prompts. [Learn more](../Automation-Security/) ![](../images/commercial.png) * **Integrated security** – Uses your operating system’s security system to store passwords securely. [Learn more](../Integrated-Security/) Note For the Community Edition, Integrated Security is the only available option. ![](../images/ug/Security-preferences.png) ## Changing the password provider¶ 1. Go to **Window - > Preferences -> General -> Security**. 2. Select your preferred provider. 3. Click **Apply** and follow prompts to confirm and update your settings. ## Enabling database secure password storage¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. By default, only global configuration settings are saved in secure storage. Otherwise, database credentials are kept in local [configuration files](../Configuration-files-in-DBeaver/). To store database connection credentials securely: 1. In the **Security** tab, find the **Encrypted Data** section. 2. Check **Database connection credentials**. 3. Click **Apply**. ## Advanced mode¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/) and [Ultimate](../Ultimate-Edition/) editions only. Use **Advanced mode** to gain full control over secure storage settings, including encryption preferences and management of individual secured resources. 1. Navigate to **Window - > Preferences -> General -> Security**. 2. In the **Encrypted data** section, click the **See what secured data was saved** button. In the opened window: * The **Contents** tab allows you to: * Review the resources that are secured. This includes resources protected by the Master Password and those secured through integrated operating system (OS) security mechanisms. * Delete entries if necessary to remove security constraints from the resources. * The **Advanced** tab allows you to set the encryption algorithm for new storages. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Separate-Connections/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * Multiple datasource connections [ Multiple datasource connections ](./) Table of contents * Metadata * SQL Editor * Options * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Metadata * SQL Editor * Options 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Multiple datasource connections ## Metadata¶ Opening separate metadata connection may increase performance because there will be no UI locks during query execution. You can set up opening separate connection for metadata read globally in Preferences->Connections->Metadata or per each connection in Connection configuration->Metadata. ![](../images/separate-connection-meta.png) ## SQL Editor¶ Opening separate connection for SQL Editor may allow you to have different execution context for each script. You can set up opening separate connection for each editor in Preferences->Editors->SQL Editor and Connection configuration->SQL Editor and Connection configuration->SQL Editor. ![](../images/separate-connection-editor.png) ## Options¶ `Always` option means that DBeaver will create separate connections for SQL Editor and/or metadata read. If you choose `Never` option, then DBeaver will use single connection - no new connections will be opened. `Default` option means that DBeaver will create separate connections for SQL Editor and/or metadata read for most databases except these: * SQLServer Azure Entra ID MFA * BigQuery * BigTable * Spanner * Apache Hadoop, Apache Drill, Apache Kyuubi, Apache Spark, Apache Hive, SnappyData, Gemfire XD, Apache Phoenix * Redshift * Snowflake Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Session-Manager-Guide/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * Session Manager [ Session Manager ](./) Table of contents * Supported databases * How to use * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported databases * How to use 1. [DBeaver](/docs/dbeaver) 2. Integrated tools # Session Manager The Session Manager in DBeaver provides you with control and visibility into your sessions, allowing you to terminate, disconnect, view and search for sessions, as well as perform several other actions. ## Supported databases¶ * Altibase * [AlloyDB](../Database-driver-AlloyDB-for-PostgreSQL/) * [Db2 for LUW](../Database-driver-IBM-Db2/) * Exasol * Fujitsu Enterprise Postgres * [Greenplum](../Database-driver-Greenplum/) * [MariaDB](../Database-driver-MariaDB/) * [MongoDB](../MongoDB/) * [MySQL](../Database-driver-MySQL/) * [MySQL on Google Cloud](../Database-driver-MySQL-on-Google-Cloud/) * [Netezza](../Database-driver-Netezza/) * [Oracle](../Oracle/) * [PostgreSQL](../Database-driver-PostgreSQL/) * [PostgreSQL on Google Cloud](../Database-driver-PostgreSQL-on-Google-Cloud/) * [Redshift](../Database-driver-Amazon-Redshift/) * [Microsoft SQL Server](../Database-driver-Microsoft-SQL-Server/) * [Microsoft SQL Server on Google Cloud](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) ## How to use¶ To open the Session Manager: 1. In the [**Database Navigator**](../Database-Navigator/), navigate to your desired database. 2. Go to the **Administer** section. 3. Double-click on **Session Manager** or right-click and select **View Session Manager**. ![](../images/ug/tools/session_manager/session-manager-editor.png) Once you have opened the **Session Manager** , you will have access to a variety of functionalities based on your database type. To access these functionalities, you must right-click on the desired session, or select the session and use the buttons in the bottom toolbar of the Editor. Here is a rundown of the buttons and their functionalities: Button | Image | Description ---|---|--- **Kill Session** | ![](../images/ug/tools/session_manager/kill-session-button.png) | Terminates the selected session forcefully. **Disconnect Session** | ![](../images/ug/tools/session_manager/disconnect-session-button.png) | Disconnects the selected session from the server. **Show Active/All Connections** | ![](../images/ug/tools/session_manager/show-all-connection-button.png) | Toggles between displaying only the active sessions and all sessions in your database. **Show Background** | ![](../images/ug/tools/session_manager/show-background-connection-button.png) | Reveals background processes that are running in the session. **Show Inactive** | ![](../images/ug/tools/session_manager/show-inactive-connection-button.png) | Shows the sessions that are currently inactive in your database. **Refresh** | ![](../images/ug/tools/session_manager/refresh-sessions-button.png) | Updates the session list to reflect the current state of the database. **Configure Auto-Refresh** | ![](../images/ug/tools/session_manager/configure-auto-refresh-button.png) | Allows you to set up automatic refreshing of the session list. **SQL Script** | ![](../images/ug/tools/session_manager/sql-button.png) | Calls a SQL script that will display sessions in a table format. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Shortcuts/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * Shortcuts [ Shortcuts ](./) Table of contents * Connection * Result Set * Result Set (Additional shortcuts for DBeaver Keyboard Only key scheme) * Panels * Data Editor * Text Editor * SQL Editor * Diagrams * Visual Query Builder * Search * Data viewer * Window * Database Navigator * Properties Entity Editor * Navigation tree * File * Run/Debug * Git * Project * Oracle * Utility * Help * References * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Connection * Result Set * Result Set (Additional shortcuts for DBeaver Keyboard Only key scheme) * Panels * Data Editor * Text Editor * SQL Editor * Diagrams * Visual Query Builder * Search * Data viewer * Window * Database Navigator * Properties Entity Editor * Navigation tree * File * Run/Debug * Git * Project * Oracle * Utility * Help * References 1. [DBeaver](/docs/dbeaver) 2. DBeaver configuration # Shortcuts Here is a complete list of default hotkeys in DBeaver UI for Windows, Linux, and macOS users. It will help you work in DBeaver faster and more efficiently. Remember that you can always change the keyboard shortcut in the DBeaver settings. Go through: **Window - > Preferences -> User Interface -> Keys**. Select command and add a keyboard shortcut to the **Binding row**. If you mostly use keyboard, to get more shortcuts you can switch default key scheme to **DBeaver Keyboard Only** key scheme in **Window - > Preferences -> User Interface -> Keys** settings. ## Connection¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- F4 | F4 | Open object editor Ctrl+Shift+N | Ctrl+Shift+N | Open **Connect to a database** window Ctrl+Shift+D | ⌃⇧D | Open database meta-object Ctrl+Alt+Enter | ⌃⌥↩ | Open a new SQL console. No script file will be created. Ctrl+] | ⌃] | Create a new SQL script F3 | F3 | Open existing SQL script Ctrl+Enter | ⌘↩ | Open most recent SQL script for an active connection Ctrl+Alt+Shift+K | ⌃4 | Commit changes in current session Alt+` | ⌃V | Shows context menu with database tools Ctrl+Alt+Shift+U | ⌃⌥⇧U | Generates UUID/GUID and inserts into an active text editor or data editor Ctrl+Alt+Shift+B | ⌃⌥⇧B | Open database dashboard Ctrl+Alt+Shift+R | ⌃8 | Rollback changes in current session Ctrl+0 | ⌃0 | Select active schema for current database Ctrl+9 | ⌃9 | Select connection for current editor Alt+Shift+Down/Up | Alt+⌥+Down/Up | Switch vertical tabs ## Result Set¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Alt+Insert | ⌥Insert | Add new row Ctrl+D | ⌃D | Copy values from row above to current row Ctrl+Alt+D | ⌃⌥D | Copy values from row below to current row Alt+Delete | ⌥⌦ | Delete current row Ctrl+Alt+Insert | ⌃⌥Insert | Duplicate current row Enter | ↩ | Edit cell value with inline editor Esc | Esc | Reset cell to original value Ctrl+S | ⌃S | Apply data changes Ctrl+Alt+Shift+T | ⌃⌥⇧T | Set focus to filter editor/data editor Ctrl+Shift+7 | ⌃⇧7 | Switch focus to results viewer/active panel Ctrl+Tab | Ctrl+Tab | Switch focus between the Grid view and the Value panel Ctrl+Alt+Shift+Enter | ⌃⌥⇧↩ | Apply cell changes Shift+Enter | ⇧↩ | Edit cell value in separate dialog/editor Ctrl+Shift+= | ⌃⇧= | Fetch all rows Ctrl+Alt+N | ⌃⌥N | Fetch next page of results Ctrl+F11 | ⌃F11 | Filter by unique attribute values F11 | F11 | Filter context menu Ctrl+Alt+Shift+Left | ⌃⌥⇧← | Move to first row Ctrl+Alt+Shift+Right | ⌃⌥⇧→ | Move to last row Alt+Space | ⌥Space | Follow foreign key link Ctrl+Alt+Right | ⌃⌥→ | Move to next row Ctrl+Alt+Left | ⌃⌥← | Move to previous row Ctrl+Shift+1 | ⌃⇧1 | Foreign keys and tables referencing current table Ctrl+R | ⌃R | Reject data changes Ctrl+Backspace | ⌃⌫ | Set cell to default value Ctrl+` | ⌃` | Switch results presentation Tab | Tab | Toggle results Grid/Record view F7 | F7 | Toggle result panels Ctrl+2 | ⌃2 | Toggle results sort order (ascending/descending/default) Ctrl+Alt+C | | Select column(s) Ctrl+Alt+R | | Select row(s) Shift+F11 | | Show context menu for column Ctrl+G | | Go to row Ctrl+Shift+G | | Go to column Alt+9 | ⌘+⌥+9 | Zoom out (decrease default font size) Alt+0 | ⌘+⌥+0 | Zoom in (increase default font size) ## Result Set (Additional shortcuts for DBeaver Keyboard Only key scheme)¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Alt+Shift+Right | | Move column(s) right Alt+Shift+Left | | Move column(s) left Alt+Shift+C | | Copy column names Alt+Shift+H | | Hide columns Alt+Shift+T | | Show hidden columns Alt+Shift+F | | Open filters settings ## Panels¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- F7 | F7 | Toggle results panels Ctrl+Alt+F6 | ⌃+⌥+F6 | Show/hide results panel (Calc) Ctrl+Alt+F5 | ⌃+⌥+F5 | Show/hide results panel (Grouping) Ctrl+Alt+F4 | ⌃+⌥+F4 | Show/hide results panel (Metadata) Ctrl+Alt+F3 | ⌃+⌥+F3 | Show/hide results panel (References) Ctrl+Alt+F2 | ⌃+⌥+F2 | Show/hide results panel (Value) ## Data Editor¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+Space | ⌃Space | Enable autocomplete Ctrl+F | ⌘F | Find and replace text Ctrl+Shift+Space | ⌃⇧Space | Show Context Information in DIalogs and Windows Ctrl+Alt+Space | ⌃⌥Space | Show Context Information (SQL Editor Context) Ctrl+X | ⌘X | Cut the selection to the clipboard Ctrl+C | ⌘C | Copy the selection to the clipboard Ctrl+V | ⌘V | Paste from the clipboard Delete | ⌦ | Delete the selection Ctrl+O | ⌘O | Export Diagram Ctrl+K | ⌘K | Find next item Ctrl+Shift+K | ⇧⌘K | Find previous item Ctrl+J | ⌘J | Incremental find Ctrl+Shift+J | ⇧⌘J | Incremental find reverse Ctrl+Shift+Q | ⌃⇧Q | Toggles quick diff information display on the line number ruler Ctrl+1 | ⌘1 | Suggest possible fixes for a problem Ctrl+Y | ⇧⌘Z | Redo the last operation Ctrl+Z | ⌘Z | Undo the last operation Shift+Delete | ⇧⌦ | Remove selected Pictogram Elements Ctrl+A | ⌘A | Select all Alt+Shift+A | ⌥⌘A | Toggle block/column selection in the current text editor Ctrl+Shift+Insert | ⇧⌘Insert | Toggle insert mode Alt+Shift+Y | ⌥⌘Y | Toggle word wrap in the current text editor Ctrl+F5 | ⌘F5 | Update selected Pictogram Elements Alt+/ | ⌃. | Context insensitive completion Ctrl+Shift+Space | ⌃⇧Space | Context insensitive completion (SQL Editor Context) ## Text Editor¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+Shift+Y | ⇧⌘Y | Changes the selection to lowercase Ctrl+Shift+X | ⇧⌘X | Changes the selection to uppercase Ctrl+Numpad_Subtract | ⌘Numpad_Subtract | Collapses the folded region at the current selection Ctrl+Shift+Numpad_Divide | ⇧⌘Numpad_Divide | Collapses all folded regions Ctrl+Alt+Down | ⌥⌘↓ | Duplicates the selected lines and moves the selection to the copy Ctrl+D | ⌘D | Delete a line of text Ctrl+Delete | ⌥⌦ | Delete the next word Ctrl+Backspace | ⌥⌫ | Delete the previous word Ctrl+Shift+Delete | ⇧⌘⌦ | Delete to the end of the line of text Ctrl+Alt+Up | ⌥⌘↑ | Duplicates the selected lines and leaves the selection unchanged Ctrl+Numpad_Add | ⌘Numpad_Add | Expands the folded region at the current selection Ctrl+Numpad_Multiply | ⌘Numpad_Multiply | Expands all folded regions Ctrl+Shift+Enter | ⇧⌘↩ | Adds a new line above the current line Shift+Enter | ⇧↩ | Adds a new line below the current line Ctrl+Alt+J | | Join lines of text (Editing Text) Ctrl+Shift+J | ⌃⇧J | Join lines of text (SQL Editor Context) End | ⌘→ | Go to the end of the line of text Home | ⌘← | Go to the start of the line of text Alt+Down | ⌃⇧↓ | Moves the selected lines down (Editing Text) Ctrl+Shift+Down | ⌥↓ | Moves the selected lines down (SQL Editor Context) Alt+Up | ⌃⇧↑ | Moves the selected lines up (Editing Text) Ctrl+Shift+Up | ⌥↑ | Moves the selected lines up (SQL Editor Context) Ctrl+Right | ⌥→ | Go to the next word Ctrl+Left | ⌥← | Go to the previous word Ctrl+Shift+Numpad_Multiply | ⇧⌘Numpad_Multiply | Resets the folding structure Ctrl+Down | | Scroll down one line of text Ctrl+Up | | Scroll up one line of text Shift+End | ⇧⌘→ | Select to the end of the line of text Shift+Home | ⇧⌘← | Select to the beginning of the line of text Ctrl+Shift+Right | ⌥⇧→ | Select the next word Ctrl+Shift+Left | ⌥⇧← | Select the previous word | ⇧↘ | Select to the end of the text | ⇧↖ | Select to the beginning of the text F2 | F2 | Displays information for the current caret location in a focused hover Ctrl+End | ↘ | Go to the end of the text Ctrl+Home | ↖ | Go to the beginning of the text Ctrl+Numpad_Divide | ⌘Numpad_Divide | Toggles folding in the current editor Insert | Insert | Toggle overwrite mode Ctrl++ | ⌘+ | Zoom in text, increase default font size for text editors Ctrl+= | ⌘= | Zoom in text, increase default font size for text editors Ctrl+- | ⌘- | Zoom out text, decrease default font size for text editors ## SQL Editor¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Alt+X | ⌥X | Execute SQL script Alt+N | ⌥N | Execute SQL script natively Ctrl+Enter | ⌘↩ | Execute SQL statement Ctrl+ | ⌃ | Execute SQL statement in a new tab Ctrl+Alt+Shift+X | ⌃⌥⇧X | Execute script's statements in separate results tabs Ctrl+/ | ⌃/ | Add or remove single line comment Ctrl+Shift+/ | ⌃⇧/ | Add or remove multi line comment Ctrl+Alt+Shift+T | ⌃⌥⇧T | Switch active SQL editor panel Ctrl+T | ⌃T | Show/hide results panel Ctrl+Shift+\ | ⌃⇧\ | Close results tab Ctrl+Shift+F | ⌃⇧F | Format text Ctrl+Alt+' | ⌃⌥' | Select value of the selected SQL expression Ctrl+Shift+E | ⌃⇧E | Explain execution plan Ctrl+Shift+[ | ⌃⇧[ | Jump to the corresponding bracket Ctrl+Shift+] | ⌃⇧] | Select the text between brackets Ctrl+Alt+Shift+O | ⌃⌥⇧O | Load SQL script from file system Ctrl+Shift+T | ⌃⇧T | Maximize/normalize results panel Alt+Down | ⌥↓ | Switch to the next query Alt+Up | ⌥↑ | Switch to the previous query Ctrl+F2 | ⌃F2 | Rename current SQL script F4 | F4 | Open editor of current (highlighted) database object Ctrl+Alt+Shift+A | ⌃⌥⇧A | Select and show all rows (no fetch size limit) Ctrl+Alt+Shift+C | ⌃⌥⇧C | Select row count for query under cursor Ctrl+Shift+. | ⌃⇧. | Set active connection from database navigator selection Ctrl+Shift+O | ⌃⇧O | Show server output console Ctrl+Alt+Shift+W | ⌃⌥⇧W | Toggles text editor soft word wrap Ctrl+Shift+I | ⌃⇧I | Switch presentation to (AI Chat) Alt+Ctrl+→ | ⌥+⌘+→ | Trigger AI query suggestion. Press `→`, `Tab`, or `Enter` to insert the suggestion. Press `Esc` to dismiss it. ## Diagrams¶ See [Diagrams documentation](../ER-Diagrams/#bindings) for a list of shortcuts. ## Visual Query Builder¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+B | ⌃B | Open Visual Query Builder Ctrl+Shift+B | ⌃⇧B | Show/hide generated SQL query text Ctrl+Alt+PageUP/PageDown Ctrl+Shift+PageUP/PageDown | Ctrl+⌥+PageUP/PageDown Ctrl+⇧+PageUP/PageDown | Switch vertical tabs Alt+1 | ⌥1 | Changes focus to the main tab Alt+2 | ⌥2 | Changes focus to the palette Alt+3 | ⌥3 | Changes focus to the outline Alt+4 | ⌥4 | Changes focus to parameters Alt+5 | ⌥5 | Switches to Visual Query Builder settings part Alt+6 | ⌥6 | Switches to query preview Important The shortcuts `Alt+1` through `Alt+6` are only effective in the DBeaver Keyboard Scheme. ## Search¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+H | ⌃H | Open the Search dialog Ctrl+Alt+G | ⌥⌘G | Searches the files in the workspace for specific text Ctrl+Alt+Shift+F | ⌥⇧⌘L | Quick search in Windows ## Data viewer¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Tab | Tab | Cycle through hand tool and previously used tool Ctrl+= | ⌘= | Zoom In Ctrl+- | ⌘- | Zoom Out Alt+Shift+Q, Q | ⌥⌘Q Q | Shows a particular view Alt+Shift+Q, B | ⌥⌘Q B | Shows a particular view (Breakpoints) Alt+Shift+Q, C | ⌥⌘Q C | Shows a particular view (Console) Alt+Shift+Q, L | ⌥⌘Q L | Shows a particular view (Error Log) Alt+Shift+Q, Z | ⌥⌘Q Z | Shows a particular view (History) Alt+Shift+Q, O | ⌥⌘Q O | Shows a particular view (Outline) Alt+Shift+Q, X | ⌥⌘Q X | Shows a particular view (Problems) Alt+Shift+Q, S | ⌥⌘Q S | Shows a particular view (Search) Alt+Shift+Q, Y | ⌥⌘Q Y | Shows a particular view (Synchronize) Alt+Shift+Q, V | ⌥⌘Q V | Shows a particular view (Variables) ## Window¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- F12 | ⌘F12 | Activate Editor | ⌘W | Closes the active Dialog Ctrl+3 | ⌘3 | Find actions. Quickly access UI elements Ctrl+M | ⌃M | Maximize/restore a state of active view or editor Ctrl+F6 | ⌘F6 | Switch to the next editor Ctrl+F8 | ⌘F8 | Switch to the next perspective Ctrl+F7 | ⌘F7 | Switch to the next view Ctrl+Shift+F6 | ⇧⌘F6 | Switch to the previous editor Ctrl+Shift+F8 | ⇧⌘F8 | Switch to the previous perspective Ctrl+Shift+F7 | ⇧⌘F7 | Switch to the previous view Ctrl+E | ⌘E | Open the editor drop-down list | ⇧F10 | Show the context menu Alt+Shift+F3 | ⌥⇧F3 | Shows contribution information for the currently selected element Ctrl+Shift+L | ⇧⌘L | Show the key assist dialog Ctrl+F10 | ⌘F10 | Show the context menu for the ruler Alt+- | ⇧⌘F10 | Show the system menu Ctrl+F10 | ⌘F10 | Show the view menu Ctrl+Shift+E | ⇧⌘E | Switch to an editor Alt+F11 | ⌃⌘F | Toggles the window between full screen and normal Ctrl+_ | ⇧⌘- | Split or join the currently active editor (Horizontal) Ctrl+_ | ⇧⌘[ | Split or join the currently active editor (Vertical) ## Database Navigator¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+Shift+, | ⌃⇧, | Link with editor Ctrl+Alt+Shift+D | ⌃⌥⇧D | Add Bookmark Enter | ↩ | Opens task configuration Ctrl+Shift+A | ⌃⇧A | Set as default object ## Properties Entity Editor¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Alt+Shift+Up | Alt+Shift+Up | Switch to the next entity property left-side tab Alt+Shift+Down | Alt+Shift+Down | Switch to the previous entity property left-side tab Ctrl+Alt+PageUP/PageDown Ctrl+Shift+PageUP/PageDown | Ctrl+⌥+PageUP/PageDown Ctrl+Shift+PageUP/PageDown | Switch vertical tabs ## Navigation tree¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Alt+Left | ⌘[ | Move backward in the editor navigation history Ctrl+Shift+Numpad_Divide | ⇧⌘Numpad_Divide | Collapse the current tree Ctrl+Shift+Numpad_Multiply | ⇧⌘Numpad_Multiply | Expand the current tree Alt+Right | ⌘] | Move forward in the editor navigation history Ctrl+G | ⌃G | Go to a specified line of text in Windows Ctrl+L | ⌘L | Go to a specified line of text (Editing Text) Ctrl+. | ⌘. | Navigate to the next item Ctrl+Alt+Right | ⌃⌥→ | Next edit location Alt+F7 | ⌥F7 | Switch to the next page Alt+PageDown | ⌥⇟ | Switch to the next sub-tab Ctrl+PageDown | ⌃⇟ | Switch to the next tab Ctrl+Shift+R | ⇧⌘R | Open an editor on a particular item Ctrl+, | ⇧⌘. | Navigate to the previous item Ctrl+Alt+Left | ⌃Q | Previous edit location Alt+Shift+F7 | ⌥⇧F7 | Switch to the previous page Alt+PageUp | ⌥⇞ | Switch to the previous sub-tab Ctrl+PageUp | ⌃⇞ | Switch to the previous tab Alt+Shift+W | ⌥⌘W | Open the Show In menu ## File¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- F2 | F2 | Rename the selected item F5 | F5 | Refresh the selected items Ctrl+S | ⌘S | Save the changes in current file Ctrl+Shift+S | ⇧⌘S | Save changes in all open files Ctrl+F4 | ⌘W | Close the active editor Ctrl+Shift+F4 | ⇧⌘W | Close all editors Ctrl+N | ⌘N | Open the New item wizard Alt+Shift+N | ⌥⌘N | Open the New menu Ctrl+O | ⌃O | Open a file Ctrl+P | ⌘P | Print Alt+Enter | ⌘I | Display the properties of the selected item ## Run/Debug¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+Alt+M | ⌥⌘M | Add memory block Ctrl+W | ⌘W | Close the selected rendering F11 | ⌘F11 | Launch in debug mode Ctrl+Z | ⌃D | Send end of file Ctrl+G | ⌘G | Go to Address Ctrl+N | ⌘N | Add a new rendering Ctrl+Alt+N | ⌥⌘N | Show renderings from next memory monitor. Ctrl+Shift+. | ⇧⌘. | Load next page of memory Ctrl+Shift+, | ⇧⌘, | Load previous page of memory Ctrl+F11 | ⇧⌘F11 | Launch in run mode Ctrl+R | ⌘R | Resume and break when execution reaches the current line Ctrl+Alt+B | ⌃⌥B | Sets whether or not any breakpoint should suspend execution F5 | F5 | Step into F6 | F6 | Step over F7 | F7 | Step return F8 | F8 | Resume Ctrl+F2 | ⌘F2 | Terminate Ctrl+Shift+B | ⇧⌘B | Creates or removes a breakpoint Ctrl+T | ⌘T | Toggle visibility of the Memory Monitors Pane Shift+F5 | ⇧F5 | Toggles enablement of debug step filters ## Git¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+Left | ⌘← | Collapse Working Tree Ctrl+# | ⌥⌘3 | Commit Ctrl+C | ⌘C | Copy Path to Clipboard Ctrl+O | ⌘O | Show the quick outline for a unified diff F2 | F2 | Rename Branch Ctrl+Shift+K | ⌃⇧K | Commit changes to Git Ctrl+Shift+U | ⌃⇧U | Update changes from Git ## Project¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+B | ⌘B | Build all projects ## Oracle¶ Shortcut for Windows/Linux | Shortcut for macOS | Action ---|---|--- Ctrl+F9 | ⌃F9 | Compile ## Utility¶ Shortcut for Windows&Linux | Shortcut for macOS | Action ---|---|--- Ctrl+Shift+C | ⌃⇧C | [Advanced Copy](../Data-Viewing-and-Editing/#advanced-copy) Ctrl+Alt+Shift+C | ⌃⌥⇧C | Copy data with settings in advanced copy Ctrl+Shift+V | ⌃⇧V | [Advanced paste](../Data-Viewing-and-Editing/#advanced-paste) CTRL+ALT+PAGE_UP CTRL+ALT+PAGE_DOWN | | Switch between tabs in database object Properties view Alt+Insert | ⌘+N | Create Object It is available both in the **Database Navigator** and the **Properties Editor**. ## Help¶ Shortcut for Windows&Linux | Shortcut for macOS | Action ---|---|--- F1 | F1 | Open the documentation ### References¶ `*` \- Current query is the query under cursor or the selected text. Query is separated from other script queries by delimiter (; by default) or by empty lines. `**` \- Current script is a set of all queries in the current SQL file. If there is a text selection then only queries in this selection are processed. Queries are separated from each other with a delimiter (; by default). `***` \- Current connection detected from active window and selection. If active (focused) window is SQL editor or database object editor then the current connection is the same as in this editor. If the active window is the database navigator then the active connection is the "owner" connection of the currently selected element. In other cases there is no current connection and DBeaver will ask you to choose the connection explicitly. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Simple-and-Advanced-View/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * Simple and advanced view [ Simple and advanced view ](./) Table of contents * Accessing Connection view modes * View modes features * Additional settings * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Accessing Connection view modes * View modes features * Additional settings 1. [DBeaver](/docs/dbeaver) 2. [Navigation](/docs/dbeaver/Database-Navigator) 3. Database Navigator # Simple and advanced view The Database Navigator in DBeaver displays various database objects by default, including system objects, schemas, tables, indexes, utilities, and more. To customize or simplify the [Database Navigator's](../Database-Navigator/) contents, you may choose from three view modes: * **Simple** : This mode offers a streamlined view, ideal for users who primarily interact with tables. * **Advanced** : This mode provides a comprehensive view of all database objects that DBeaver can manage. * **Custom** : This mode allows for a personalized configuration of the Database Navigator display. ![](../images/ug/Simple-and-advanced-views-overview.png) ## Accessing Connection view modes¶ To access these settings: 1. Right-click on the desired database within the Database Navigator. 2. Select **Connection view**. 3. Choose between **Simple** , **Advanced** , or **Custom** to suit your preferences. For the **Custom** view: 1. After selecting **Custom** , an additional window will appear. 2. In this window, you can configure the custom settings for the Database Navigator view. Important Changing the view modes settings affects the currently selected database. To customize the display of objects in each database individually, you must select a specific view mode for each one. ## View modes features¶ Each view mode offers a unique set of features: * **Simple View** : Tailored for ease of use, the **Simple view** offers a minimalist approach, displaying only schemas and tables. It is optimal for users who focus predominantly on these database objects. * **Advanced View** : The **Advanced view** presents a comprehensive display of the database, showing all database objects, including system objects, all folders, and all supported objects. This mode is intended for users who require visibility across the entire database structure. * **Custom View** : For those who prefer a personalized setup, the **Custom view** mode provides the ability to configure the Database Navigator. Following is a detailed comparison of the features across the different view modes, along with descriptions for the configurable options available in the **Custom View** : Feature | Simple View | Advanced View | Custom View (Configurable) | Description ---|---|---|---|--- **Show system objects** | No | Yes | Yes/No | Includes or excludes system objects such as `pg_catalog` or `SYSTEM`. **Show utility objects** | No | Yes | Yes/No | Includes or excludes utility objects like template databases for new database creation. **Show only schemas and tables** | Yes | No | Yes/No | Displays only schemas and tables, hiding all other objects for a simplified view. **Show all tables in a single list** | No | No | Yes/No | Consolidates all tables into one list, regardless of their schema. **Hide folders** | Yes | No | Yes/No | Hides all intermediate logical folders, displaying objects directly. ## Additional settings¶ In addition to selecting a view mode, there are other settings accessible via the **Connection view** context menu. These settings provide additional information about the database objects and enhance your experience: Setting | Description ---|--- **Show connection host name** | Displays the host name or tunnel of the current database next to the connection name. **Show objects description** | Shows object (table, column, etc.) description next to it. **Show statistics info** | Provides statistical information on objects (e.g. table size), on the right side of the Database Navigator. **Show action icons** | Shows action icons for database elements. For example, you can see a read-only icon ![](../images/ug/read-only-icon.png) on the right side of the Database Navigator, indicating that a particular connection is in a read-only state. These settings can be toggled on or off based on your preference, allowing for a customized Database Navigator. To access and modify these settings: 1. Right-click on the desired database within the Database Navigator. 2. Navigate to the relevant options. 3. Select or deselect the options to show or hide the desired information. Note These settings alter the display for the entire Database Navigator, affecting how all database objects are presented. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Snap-installation/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * Snap installation [ Snap installation ](./) Table of contents * Installation * Connect interfaces: * Problems with dbeaver-ce snap package: * Workaround * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Installation * Connect interfaces: * Problems with dbeaver-ce snap package: * Workaround 1. [DBeaver](/docs/dbeaver) 2. Administration # Snap installation ## Installation¶ For install _dbeaver-ce_ snap package with stable release (stable by default): `snap install dbeaver-ce --stable` ## Connect interfaces:¶ You can find list of all _dbeaver-ce_ snap connections: `snap connections dbeaver-ce` And connect what you need. For example: `snap connect dbeaver-ce:ssh-keys` for access to private keys Or you can do it in Ubuntu Software (dbeaver-ce - Permissions): ![image](https://user- images.githubusercontent.com/46003534/172124852-bee2766f-fcee-4deb-9cab-7d132dc02aae.png) ### Problems with dbeaver-ce snap package:¶ At the moment there is a well-known problem with opening the browser and gis maps via _dbeaver-ce_ snap package. Application crashes with an error: `SWT WebKitGDBus: error creating DBus server Error binding to address (GUnixSocketAddress): Permission denied` `SWT WebKit: error initializing DBus server, dBusServer == 0` Snapcraft forum topic: https://forum.snapcraft.io/t/classic-confinement-for- dbeaver-ce/27502 ### Workaround¶ While the problem is being fixed, you can use the **workaround** : Run _dbeaver-ce_ snap package from: `/snap/dbeaver- ce/current/usr/share/dbeaver-ce/dbeaver` Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Snowflake/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * Snowflake [ Snowflake ](./) Table of contents * Snowflake specialty * Setting Up * Snowflake connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Snowflake * Snowflake database objects * Snowflake features * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Snowflake specialty * Setting Up * Snowflake connection settings * Connection details * Secure Connection Configurations * Secure Storage with Secret Providers * Powering Snowflake * Snowflake database objects * Snowflake features 1. [DBeaver](/docs/dbeaver) 2. [Databases support](/docs/dbeaver/Database-drivers) 3. [Cloud](/docs/dbeaver/Database-driver-Amazon-Athena) 4. Snowflake # Snowflake Important If your Snowflake connection stopped working after updating to version `25.0`, check the driver version. If it’s `3.13.30` or older, please [update it](../FAQ/#how-to-update-driver-version) to the latest stable release manually. This guide provides instructions on how to set up and use Snowflake with DBeaver. Before you can start managing your database, it's essential to establish a connection in DBeaver. This involves selecting the `Snowflake` option to connect to the Snowflake database. If you have not yet created a connection in DBeaver, please refer to our [Creating a Connection](../Create-Connection/) article for guidance. ![](../images/database/snowflake/snowflake-drivers.png) ## Snowflake specialty¶ Snowflake is a cloud-native data platform designed for fast, scalable analytics on large datasets. Its architecture separates storage and compute, so you can scale each independently. Snowflake handles structured and semi- structured data, supports concurrent workloads, and automatically manages performance, availability, and maintenance. Snowflake stores data in a compressed columnar format and runs queries using MPP (massively parallel processing) for high performance. For details, see the [Snowflake documentation](https://docs.snowflake.com/). Warning This database may charge for metadata queries, such as listing tables or reading schema information. These queries can trigger compute usage or per- request billing. You can turn off metadata queries to avoid extra costs. For details, see [Disable metadata queries](../Data-Editor/#disable-metadata- queries). ## Setting Up¶ This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, AWS SSM and Kubernetes. ### Snowflake connection settings¶ In this subsection, we will outline the settings for establishing a direct connection to a Snowflake database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Snowflake database. The page of the connection settings requires you to fill in specific fields to establish the initial connection. ![](../images/database/snowflake/snowflake-connection-main.png) Field | Description ---|--- **Host** | Enter the Snowflake account URL (e.g., `abcde12345.snowflakecomputing.com`). **Port** | Use port `443` for HTTPS connections. **Database** | Enter the name of the database you want to connect to. **Warehouse** | Enter the name of the virtual warehouse to use for query execution. **Schema** | Enter the name of the schema that contains your tables and views. **Authentication** | Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles: \- [Native Database Authentication](../Authentication-Snowflake/#database- native-authentication) \- [DBeaver Profile Authentication](../Authentication-DBeaver-profile/) ![](../images/commercial.png) \- [Private key](../Authentication-Snowflake/#private-key-authentication) ![](../images/commercial.png) \- [SSO (Browser)](../Authentication-Snowflake/#sso-authentication) ![](../images/commercial.png) You can also read about [security in DBeaver PRO](../Security-in-DBeaver- PRO/). **Connection Details** | Provide additional connection details if necessary. **Driver Name** | This field will be autofilled based on your selected driver type. Tip Click the **Test Connection** button to load the list of available warehouses/schemas from the server. ### Connection details¶ The **Connection Details** section in DBeaver allows you to customize your experience while working with Snowflake database. This includes options for adjusting the **Navigator View** , setting up **Security measures** , applying **Filters** , configuring **Connection Initialization** settings, and setting up **Shell Commands**. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles: * [Connection Details Configuration](../Create-Connection/#connection-details) * [Database Navigator](../Database-Navigator/) * [Security Settings Guide](../Managing-security-restrictions-for-database-connection/) * [Filters Settings Guide](../Configure-Filters/) * [Connection Initialization Settings Guide](../Configure-Connection-Initialization-Settings/) * [Shell Commands Guide](../Working-with-Shell-Commands-in-DBeaver/) ### Secure Connection Configurations¶ DBeaver supports secure connections to your Snowflake database. Guidance on configuring such connections, specifically **SSH** , **Proxy** , **Kubernetes** , and **AWS SSM** connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles: * [**SSH Configuration**](../SSH-Configuration/) * [**Proxy Configuration**](../Proxy-configuration/) * [**Kubernetes Configuration**](../Kubernetes-configuration/) ![](../images/commercial.png) * [**AWS SSM**](../AWS-SSM-Configuration/) ![](../images/commercial.png) ### Secure Storage with Secret Providers¶ DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see [Secret Providers](../Secret-Providers/). ## Powering Snowflake¶ DBeaver provides a host of features designed for Snowflake databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations. ### Snowflake database objects¶ DBeaver lets you view and manipulate a wide range of Snowflake database objects. DBeaver has extensive support for various Snowflake metadata types, allowing you to interact with a wide variety of database objects, such as: * Databases * Schemas * Tables * Columns * Primary Keys * Unique Keys * Foreign Keys * References * Views * Materialized Views ![](../images/commercial.png) * Procedures * Sequences ![](../images/commercial.png) * Stages ![](../images/commercial.png) * Pipes ![](../images/commercial.png) * Streams ![](../images/commercial.png) * Tasks ![](../images/commercial.png) * Data types ### Snowflake features¶ DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for Snowflake. Beyond regular SQL operations, DBeaver provides a range of Snowflake-specific capabilities, such as: Category | Feature ---|--- Task management | Automate workflows with **Tasks** and **Streams**. Access control | Role-based Access Control (RBAC). Authentication | Support for **SSO** and **key pair authentication**. Additional features compatible with Snowflake, but not exclusive to it: Category | Feature ---|--- Data Transfer | [Data Import](../Data-import/). | [Data Export](../Data-export/). Data Visualization | [ERD Guide](../ER-Diagrams/). Query insights | [Disable metadata queries](../Data-Editor/#disable-metadata-queries) ![](../images/database/snowflake/metadata-types.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Statistics-Collection/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * Statistics collection [ Statistics collection ](./) Table of contents * What data is shared * How is the data sent * User Control * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * What data is shared * How is the data sent * User Control 1. [DBeaver](/docs/dbeaver) 2. About DBeaver # Statistics collection DBeaver collects usage statistics to enhance the user experience and improve the application's features. This article explains the purpose behind the data collection, the type of data collected, and how it aligns with privacy policies. ## What data is shared¶ The data shared includes: * Anonymized information about the operating system and [locale](https://en.wikipedia.org/wiki/Locale_\(computer_software\)). A locale is a set of parameters that defines user-specific settings such as language, country, and formatting preferences for dates, times, and numbers. * A list of actions performed in the user interface to analyze workflow efficiency, such as opening an editor, executing a query, using the data view panel, etc. These insights help us understand how users interact with DBeaver features. * Types of databases utilized to focus on popular database support. DBeaver does not collect: * Personal information. * Sensitive details such as database connection configurations, executed queries, or database information. ## How is the data sent¶ The data is transmitted securely at the application's shutdown or during startup. To ensure transparency, you may review the collected data types in the DBeaver source code, available at [DBeaver's GitHub repository](https://github.com/dbeaver/dbeaver). ## User Control¶ You have the authority to manage your data sharing preferences. To modify these settings: 1. Navigate to **Window - > Preferences -> General -> Usage Statistics**. 2. Use the checkbox to enable or disable the sending of usage statistics. 3. Click on **Apply** to save your preferences. Note While you can opt out of data sharing, participating in the statistics collection helps us enhance DBeaver's features and user experience. We value your contribution to our continuous improvement and encourage you to join this collective effort. All data is collected using the [DBeaver Corporation Privacy Policy](https://dbeaver.com/privacy/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Tableau-integration-in-DBeaver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * Tableau integration [ Tableau integration ](./) Table of contents * Powering Tableau with DBeaver * Easy connection to existing databases * Working with custom SQL queries * Managing charts * Filling profile for Tableau connection * Adding a Tableau Profile in DBeaver * Creating a database connection * Associate DBeaver and Tableau connection * Editing Custom SQL Queries * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Powering Tableau with DBeaver * Easy connection to existing databases * Working with custom SQL queries * Managing charts * Filling profile for Tableau connection * Adding a Tableau Profile in DBeaver * Creating a database connection * Associate DBeaver and Tableau connection * Editing Custom SQL Queries 1. [DBeaver](/docs/dbeaver) 2. Integrated tools # Tableau integration Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. [Tableau](https://www.tableau.com/) is a leading data visualization and analytics platform that empowers you to connect, visualize, and share data in a way that makes it easier to understand. With its intuitive drag-and-drop interface, Tableau enables users to create interactive and shareable dashboards, providing insights into complex data sets. Having a registered Tableau account is a prerequisite for those looking to leverage Tableau's capabilities. This article explores how DBeaver integrates with Tableau, enhancing the data manipulation process. ## Powering Tableau with DBeaver¶ DBeaver's integration is compatible with both the On-premises and Cloud versions of Tableau, offering the following key features: ### Easy connection to existing databases¶ DBeaver's integration with Tableau allows you to connect effortlessly to databases already present in Tableau. This seamless connection enables you to access and manage data without complex configurations or additional tools. Learn more about creating a connection. ### Working with custom SQL queries¶ A standout feature of DBeaver's integration with Tableau is the ability to edit custom SQL queries stored in Tableau. You can modify these queries directly within DBeaver, providing a streamlined workflow for advanced data analysis. Learn more about editing custom SQL queries. ## Managing charts¶ In addition to database management and query editing, DBeaver allows for the integration and manipulation of Tableau charts directly within its interface. [Learn more about managing dashboards](../Dashboards/#tableau-charts). ## Filling profile for Tableau connection¶ To configure Tableau credentials in DBeaver, follow these steps: 1. Navigate to **Window** -> **Preferences** -> **General** -> **Tableau**. 2. In the Tableau settings, you will find the following options: Option | Description ---|--- **Enable Tableau Integration** | Enables Tableau in connections and in UI. **Tableau Profile** | Manage Tableau profiles. User profiles are displayed here, and you can work with them using the buttons: ![](../images/ug/tableau/add-profile-button-tableau.png) \- Add profile ![](../images/ug/tableau/remove-profile-button-tableau.png) \- Remove profile ![](../images/ug/tableau/edit-profile-button-tableau.png) \- Edit profile **Test Connection** | Test the connection between DBeaver and Tableau. **Automatically associate Tableau connections** | Automatically associate Tableau connections with DBeaver data sources. Learn more about associate connection. ### Adding a Tableau Profile in DBeaver¶ When you click on **Add Profile** , a **Create new Tableau profile** window will appear. This is how you fill out the profile: ![](../images/ug/tableau/create-new-profile-tableau.png) Field | Description ---|--- **Profile name** | The name of the profile in DBeaver (choose a convenient name for yourself). **Site URL** | The URL should look like this: `https://prod-uk-a.online.tableau.com`. **SITE ID (required for Tableau Cloud)** | Enter the correct `SITE ID` used during Tableau registration (e.g., copy `testaccountcom` from your Tableau home page URL like `https://prod-uk-a.online.tableau.com/#/site/testaccountcom/home`). **Trust self-signed certificate** | Allows not to validate the server certificate. This option is useful if you are using a self-signed certificate and need it to pass validation. For more information on managing certificates, you can refer to our [article about trust stores](../Managing-Truststore-Settings/). **Authentication** | Use the credentials of the account you use (login/password or token name/value). After filling out the profile details, you can test the connection to Tableau to ensure that everything is set up correctly. This step verifies that the provided information is accurate and that DBeaver can successfully communicate with Tableau. ## Creating a database connection¶ **Important** : Before creating a connection in DBeaver, a connection must already be configured in Tableau. More details can be found [in the official Tableau documentation](https://help.tableau.com/current/pro/desktop/en- us/clipboard_datasource.htm). Creating a connection between DBeaver and Tableau is a straightforward process: 1. In the DBeaver [toolbar](../Application-Window-Overview/#toolbar), click on the **Show View (Tableau)** button ![](../images/ug/tableau/tableau-button.png). The Tableau view will open in the lower part of DBeaver, displaying your profiles. 2. In your profile, select the desired database, right-click, and choose **Create Database Connection**. 3. DBeaver will prompt you to name the connection, and it will appear in the [**Database Navigator**](../Database-Navigator/). ![](../images/ug/tableau/create-database-connection-tableau.png) ### Associate DBeaver and Tableau connection¶ The **Associate with connection** button allows you to view a list of databases that can be associated with Tableau in DBeaver. It can automatically find the database based on the hosts. Tip If the **Automatically associate Tableau connections** option is selected in the preferences, clicking on a table will automatically open it in DBeaver. To configure the database that is associated with Tableau, you can use the **Open Tableau connections** option or double-click the database in Tableau view. A window with connections that are associated with Tableau will appear. From this window, you can choose to **Link database connection** , **Unlink connection** , or **Edit connection** as needed. ![](../images/ug/tableau/associate-connection-tableau.png) ## Editing Custom SQL Queries¶ Working with custom SQL queries in Tableau can be challenging, especially when it comes to complex data manipulation. DBeaver's integration with Tableau offers a solution, allowing you to edit and manage custom SQL queries with ease. By connecting Tableau to DBeaver, you can leverage DBeaver's robust SQL editing tools to enhance your data analysis workflow in Tableau. Important The custom SQL query must already be configured in Tableau. More details can be found [in the official Tableau documentation](https://www.tableau.com/drive/custom-sql). This is how you can edit custom SQL queries using DBeaver: 1. In the Tableau view in DBeaver, select the Custom SQL query in your profile. You can double-click it, right-click and choose **Open Custom SQL** , or press the shortcut `F4`. 2. The [SQL Editor](../SQL-Editor/) will open, where you can work with the query just like any other query in DBeaver. You can make necessary changes, utilize [grouping](../Grouping-Panel/), [filters](../Data-Filters/), and other functionalities, and save and execute the query to see the changes reflected in Tableau. Note It is essential to save the query in DBeaver to ensure that the changes are also reflected and saved in Tableau. ![](../images/ug/tableau/custom-sql-query-tableau.png) This integration simplifies the process of working with custom SQL queries in Tableau, making it more efficient and user-friendly. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Task-Management/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * Task management [ Task management ](./) Table of contents * Database Tasks view * Toolbar actions * Context menu actions * Create tasks * Task setup * Manage tasks * Add, edit, or delete tasks * Run a task * Run tasks from the command line * Adjusting task configurations * Scheduling tasks * Set task timeout * Customize the Database Tasks view * Group tasks * Configure columns * Folders * Move tasks between folders * Delete a folder * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Database Tasks view * Toolbar actions * Context menu actions * Create tasks * Task setup * Manage tasks * Add, edit, or delete tasks * Run a task * Run tasks from the command line * Adjusting task configurations * Scheduling tasks * Set task timeout * Customize the Database Tasks view * Group tasks * Configure columns * Folders * Move tasks between folders * Delete a folder 1. [DBeaver](/docs/dbeaver) 2. Tasks # Task management Note This feature is available in Community, [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. Use tasks to save and reuse configurations for database tools like data transfer or import/export. Tasks help you automate routine actions and run them with one click. You can create tasks from tool wizards or from the main menu, group them in folders, and manage them in a dedicated view. ## Database Tasks view¶ All your tasks are stored in the **Database Tasks** view. Use it to review, organize, and run tasks when you need them. From this view, you can: * Add, edit, or delete tasks. * See task information. * Run tasks manually. * Schedule tasks. ![](../images/ug/tools/task_manager/task-view.png) To open it: * Go to **Database - > Tasks -> Database Tasks**, * Or click **Open Tasks view** (![](../images/ug/tools/task_manager/open-database-tasks-button.png)) from the task creation wizard. ### Toolbar actions¶ The toolbar includes quick-access buttons: Icon | Name | Description ---|---|--- ![](../images/ug/tools/task_manager/schedule-task-button.png) | **Open scheduler** | Configure time-based task runs. ![](../images/ug/Refresh-button.png) | **Refresh** | Reload the task list. ![](../images/ug/tools/task_manager/group-tasks-by-category.png) | **Group by category** | Toggle grouping by category (Common/Database-specific). ![](../images/ug/tools/task_manager/group-tasks-by-type.png) | **Group by type** | Toggle grouping by type (Export, Import, etc.). ![](../images/ug/tools/task_manager/run-task-button.png) | **Run task** | Start the selected task manually. ![](../images/ug/tools/task_manager/view-menu-button.png) | **View menu** | Open options to create a new task, add a folder, or delete items. Tip You can also right-click a task in the list to access these actions. ### Context menu actions¶ Right-click any task in the **Database Tasks** view to access task actions: Action | Description ---|--- **Run task** | Execute the selected task immediately. **Edit task** | Open the task editor. **Create new task...** | Open the task creation wizard. **Copy** | Copy task name to clipboard. **Delete** | Remove the selected task. **Create new task folder** | Create a folder to organize tasks. **Rename folder** | Rename a selected folder. **Scheduler** | Access task scheduling settings. **Group tasks by category** | Enable grouping by user-defined categories. **Group tasks by type** | Enable grouping by task type. **Copy** | Copy task info to clipboard. **Configure columns** | Choose which columns to display in the view. **Auto-size columns** | Adjust column widths to fit content. ## Create tasks¶ You can create a new task from: * Database Tasks view: Go to **Database - > Tasks -> Database Tasks** * [Menu bar](../Application-Window-Overview/#menu-bar): Go to **Database - > Tasks -> Create New Task** * [Toolbar](../Application-Window-Overview/#toolbar): click arrow next to **Open Tasks view** (![](../images/ug/tools/task_manager/open-database-tasks-button.png)) and choose **Create new task**. Note The toolbar is customizable. For further information, refer to [Toolbar Customization](../Toolbar-Customization/) article. * [Database Navigator](../Database-Navigator/): Right-click a database object, then select **Tools - > Create new task** * [Properties editor](../Properties-Editor/): Right-click a database object, then choose **Tools - > Create new task** Alternatively, you can save tasks directly from tools like [Data Transfer](../Data-transfer/), [Data Compare](../Data-compare/), [Back up and Restore](../Backup-Restore/), [Mock Data generator](../Mock-Data-Generation- in-DBeaver/). Just configure the tool, click **Save task** , fill in the task details, and save. ### Task setup¶ 1. Open the task creation wizard. ![](../images/ug/tools/task_manager/task-creation-wizard.png) 2. Fill in the task properties and choose the tool you want to automate: Field | Description ---|--- **Name** | Enter a unique name for the task. **Description** | (Optional) Add a short description to help identify the task later. **Task folder** | (Optional) Select a folder to organize tasks. **Task type** | Choose the tool you want to automate. Select from the list of task types: | **Common** : Available for any database type. | **Database-specific** : Available only for supported database types. **Max execution time (in seconds)** | (Optional) Set a time limit for task execution. Default is `300`. Note The list of available task types depends on the databases listed in **Database Navigator**. Database-specific tasks only appear if their corresponding database (like PostgreSQL, MySQL, etc.) is present. 3. Click **Next**. 4. Complete the task-specific configuration wizard. 5. Save the task when you're done. ## Manage tasks¶ To manage tasks open the Database Tasks view. ![](../images/ug/tools/task_manager/task-view.png) ### Add, edit, or delete tasks¶ You can manage tasks using the toolbar or by right-clicking a task in the **Database Tasks** view. Available actions: Action | How to use it ---|--- **Add** | Click the **View Menu** button (![](../images/ug/tools/task_manager/view-menu-button.png)) in the view's toolbar and select **Create new task...** , or right-click to open the context menu and choose **Create new task...** **Edit** | Select a task, then right-click and choose **Edit task** **Delete** | Select a task, then right-click and choose **Delete** Warning Deleted tasks can’t be restored. ### Run a task¶ 1. Select a task in the **Database Tasks** view. 2. Right-click it to open the context menu. 3. Click **Run task**. * Alternatively, use **Run task** button (![](../images/ug/tools/task_manager/run-task-button.png)) on the view’s toolbar. #### Run tasks from the command line¶ You can run saved tasks using the DBeaver [command line](../Command-Line/) interface. Use the `-runTask` parameter like this: -runTask "@projectName:taskName" Tasks run in the background without keeping the client open. If your workspace has only one project, you can omit the `@projectName:` part. On Windows, use the `dbeaverc` executable (or the legacy name `dbeaver-cli`) to run tasks. Tip Add the `-nosplash` [parameter](../Command-Line/#system-parameters) to skip the splash screen. ### Adjusting task configurations¶ The process of editing a task is similar to the process of creating a task. By double-clicking on a task or right-click and choose **Edit task** , the task edit wizard will be opened. In this wizard, you can: * Change the task properties. * Change the file format, either output for an export task or input for an import task. * Alter the set of objects for data transfer. * Adjust any export/import configuration. After modifying the task settings, click the **Save task** button. This button is located on the left side of the task configuration wizard. ### Scheduling tasks¶ Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. You can schedule tasks for later/regular execution. See the [Task Scheduler](../Task-Scheduler/) article. ### Set task timeout¶ You can set how long a task can run before it stops automatically. This helps avoid cases where one long or stuck task prevents the next ones from running. To configure it: 1. In the Database Tasks view, select or create a task. 2. Click the **Timeout** button (![](../images/ug/tools/task_manager/timeout-button.png)). Note The **Timeout** button is enabled after you finish setting up the task. 3. Choose a preset duration (1 min, 5 min, 30 min, 1 hour) or set a custom time. ## Customize the Database Tasks view¶ You can personalize how tasks are displayed in the **Database Tasks** view. Group them by type or category, and choose which columns are visible. ### Group tasks¶ To organize your task list: 1. Right-click anywhere in the task list 2. Select **Group tasks by category** or **Group tasks by type** from the context menu Tip You can enable both grouping options at the same time. ### Configure columns¶ To show or hide columns: 1. Right-click anywhere in the task list 2. Click **Configure columns** 3. Select the columns to show or hide ![](../images/ug/tools/task_manager/task-view-configure-dialog.png) ### Folders¶ You can organize tasks into folders. To create one: 1. Right-click in the **Database Tasks** view and select **Create new task folder**. 2. Enter a unique name and choose a project. #### Move tasks between folders¶ You can: * Open a task for editing, click **Back** , and change the folder. * Drag and drop tasks between folders directly in the view. #### Delete a folder¶ To remove a folder, right-click it and select **Delete**. Warning All tasks inside will also be deleted. Deleted tasks can’t be restored. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Task-Scheduler/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * Task scheduler [ Task scheduler ](./) Table of contents * Database Tasks view * Schedule a task * Update or cancel the schedule * View schedule details * Windows * macOS or Linux * Monitoring task execution * Limitations * Unix limitations * Troubleshooting * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Database Tasks view * Schedule a task * Update or cancel the schedule * View schedule details * Windows * macOS or Linux * Monitoring task execution * Limitations * Unix limitations * Troubleshooting 1. [DBeaver](/docs/dbeaver) 2. Tasks # Task scheduler Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. DBeaver lets you automate routine tasks - like exporting data or running SQL scripts - by scheduling them to run at specific times. ## Database Tasks view¶ Use the **Database Tasks** view to schedule and manage your tasks. To open the view: * navigate to **Database - > Tasks -> Database Tasks** * or go to **Window - > Database Tasks** * or click the **Show View (Database Tasks)** icon (![](../images/ug/tools/task_scheduler/task-main-toolbar.png)) in the main toolbar Note The toolbar is customizable. For further information, refer to [Toolbar Customization](../Toolbar-Customization/) article. ### Schedule a task¶ To schedule a task: 1. In the **Database Tasks** view, right-click the task you want to schedule 2. Select **Scheduler - > Schedule task** ![](../images/ug/tools/task_scheduler/task-schedule-menu.png) * or select the task you want to schedule and click the **Schedule task** icon (![](../images/ug/tools/task_scheduler/task-schedule-icon.png)) in the **Database Tasks** toolbar. 3. You'll see the scheduler configuration dialog. Here, you can set: * task frequency (hourly, daily, weekly, etc.) * recurrence pattern * start time ![](../images/ug/tools/task_scheduler/task-schedule-settings.png) Note macOS and GNU/Linux has some limitations. 4. To save the schedule click **Schedule** button * if successful, you'll see a confirmation dialog * if something goes wrong, you'll see an error dialog. Open the [**Error Log**](../Log-files/) view to get more info about what went wrong. Important When scheduling a task for the first time on macOS `10.15` or later, macOS will ask for permission. Click **Yes** to allow DBeaver to modify system `cron` settings. ### Update or cancel the schedule¶ To update or cancel the schedule: 1. Right-click the task 2. Select **Scheduler - > Edit scheduled task** to update, or **Remove schedule** to cancel ## View schedule details¶ You can view and manage scheduled tasks using your system’s built-in scheduler. Info Tasks are scheduled using: * [Windows Task Scheduler](https://learn.microsoft.com/en-us/windows/win32/taskschd/about-the-task-scheduler) on **Windows** * [cron](https://en.wikipedia.org/wiki/Cron) on **macOS** and **GNU/Linux** ### Windows¶ To open **Windows Task Scheduler** , right-click a task in the task view and select **Scheduler → Open scheduler settings**. ![](../images/ug/tools/task_scheduler/task-schedule-windows-task-manager.png) DBeaver stores all scheduled tasks in a folder named `DBeaver`. ### macOS or Linux¶ To view the `cron` entries used for task scheduling, right-click a task and select **Scheduler → Open scheduler settings**. You can also use the terminal: crontab -l Warning While you can edit the crontab using `crontab -e`, we strongly recommend not doing so manually. ## Monitoring task execution¶ You can view task execution logs on the right side of the tasks view. Double-click a task run entry to see the full log, including detailed output, errors, and warnings. ![](../images/ug/tools/task_scheduler/task-run-logs.png) Info DBeaver stores task run logs in the [workspace](../Workspace-Location/) directory, under `.metadata/task-stats`. ## Limitations¶ ### Unix limitations¶ macOS and GNU/Linux, which work on `cron` have some limitations: * no start date option * no start time for minutely tasks * seconds are ignored even if you set them * most `cron` implementations only allow minute-level granularity If you set a task to run 42 minutes past the hour, it'll run at 1:42 PM, 2:42 PM, etc. You can't configure it to run at 1:42:15 PM or only on certain dates. Warning Task start time is not guaranteed. The scheduler will try to run the task at the specified time, but execution may be delayed. ## Troubleshooting¶ See [Troubleshooting task scheduler issues](../Troubleshooting-task-scheduler- issues/) for help with scheduled tasks. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Toolbar-Customization/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * Toolbar customization [ Toolbar customization ](./) Table of contents * Top toolbar customization * SQL Editor toolbar customization * Data Editor toolbar customization * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Top toolbar customization * SQL Editor toolbar customization * Data Editor toolbar customization 1. [DBeaver](/docs/dbeaver) 2. DBeaver configuration # Toolbar customization DBeaver offers highly customizable toolbars to enhance your workflow: 1. **Top toolbar** : This toolbar is the primary control panel located at the top of the DBeaver interface. It provides quick access to various database actions, transactions, and utilities. ![](../images/ug/app-toolbar.png) 2. **SQL Editor toolbar** : Specifically designed for SQL editing, this toolbar appears when you are working within the SQL editor. It provides functionalities for executing SQL queries, navigating through your code, and other SQL-specific tasks. 3. **Data Editor toolbar** : This toolbar provides abilities for adding, editing, and exporting rows, for navigating and filtering data. Both toolbars are designed for ease of use and can be customized to fit your specific needs. From basic database operations to advanced debugging and transaction controls, these toolbars can be tailored to streamline your database management activities. ## Top toolbar customization¶ To access toolbar customization, navigate to **Window** -> **Customize Perspective** -> **Toolbar Visibility** tab. ![](../images/ug/toolbar/customize-main-toolbar.png) You can customize the Top toolbar by adding or removing various sections or individual elements based on your specific needs. Below is a table summarizing the sections available for customization: Section | Description ---|--- **Database Toolbar** | Manage database connections and navigation. For further details, see our [Database Navigator](../Database-Navigator/) article. **Transaction** | Control database transactions. **Transaction Monitor** | Monitor transaction status and logs. **DataSource Selector** | Choose active data sources and schemas. Additional information can be found in our article on [Active Database](../SQL-Editor/#active-database). **Database Tools Toolbar** | Access dashboards and views. Consult our article on [Dashboards](../Dashboards/) for more insights. **Launch** | Execute, debug, and profile code. **Debug** | Manage debug sessions and control execution. **Git** | Perform Git-related activities. **Search** | Enable quick search functionalities in code. Further reading is available in our [Search](../Search-Tool/) article. **Version Control (Team)** | Manage and synchronize with version control system. Learn more in our article about [Project Team Work](../Project-team-work/). **Working Set Manipulation** | Manage working sets for organization. **Editor Navigation** | Navigate through editor locations. **Editor Presentation** | Customize text display settings in the editor. Note Some toolbar sections may not be visible because all their child elements are in an unavailable action set. To make them available, go to the **Action Set Availability** tab and check the checkbox next to the required section. ## SQL Editor toolbar customization¶ The SQL Editor toolbar in DBeaver can be customized to streamline your SQL development workflow. To access toolbar customization options, follow one of these methods: * Navigate to **Window - > Preferences -> User Interface -> Toolbar Customization**. * Right-click within the SQL Editor window and choose **Preferences - > Toolbar Customization**. ![](../images/ug/toolbar/SQL-Editor-toolbar-customization.png) In the customization window, you can add or remove various sections and buttons. Below is a table summarizing the available sections: Section | Description ---|--- **SQL Editor bottom toolbar** | Modify technical options at the bottom of the SQL Editor. **SQL Editor top toolbar** | Customize query-related options at the top of the SQL Editor. Note For detailed explanations of the button functionalities in the SQL Editor, consult our [SQL Editor](../SQL-Editor/) article. ## Data Editor toolbar customization¶ Access the [Data Editor](../Data-Editor/) toolbar customization options through the following steps: * Go to **Window - > Preferences -> User Interface -> Toolbar Customization**. * Alternatively, execute an SQL query in the SQL Editor, then in the Results tab, click on the Configure button ![](../images/ug/Configure-button.png) and choose Toolbar Customization. Within the customization menu, you can tailor the **Result set bottom toolbar** to fit your workflow. This section allows you to alter the tools for interacting with the displayed data sets. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Transaction-Log/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * Transaction log [ Transaction log ](./) Table of contents * Transaction Log * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Transaction Log 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Transaction mode # Transaction log ## Transaction Log¶ The Transaction Log shows all transactions (queries of ‘transaction’ type such as INSERT/DELETE/UPDATE and others) made during the current DBeaver session. To open the Transaction Log, click the **Transaction log** button (![](../images/ug/Transaction-log-button.png)) in the toolbar or the statistics field to the left of it. ![](../images/ug/Transaction-Log.png) The Transaction Log window shows transactions that are: * In progress or pending - shown without any special color * Successfully committed – in green: ![](../images/ug/Transaction-status-green.png) * Rolled back – in orange or red: ![](../images/ug/Transaction-status-red.png) To see all previous transactions during the current session, select the **Show previous transactions** checkbox. To see all queries including non- transactional ones, select the **Show all queries** checkbox. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Troubleshooting-system-issues/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * Troubleshooting system issues [ Troubleshooting system issues ](./) Table of contents * Screen flickering * Mixed dark and light theme elements * Missing browser functionality * Theme parsing errors * Gtk box gadget distribute error * Disabling the AT SPI accessibility bridge * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Screen flickering * Mixed dark and light theme elements * Missing browser functionality * Theme parsing errors * Gtk box gadget distribute error * Disabling the AT SPI accessibility bridge 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Troubleshooting # Troubleshooting system issues DBeaver is an Eclipse RCP application, so it may encounter issues with GTK or certain Linux desktop environments. Below are common problems and their solutions: ## Screen flickering¶ To fix screen flickering, add this line to your `~/.profile` file: export GTK_IM_MODULE=ibus ## Mixed dark and light theme elements¶ If parts of DBeaver show a mix of light and dark colors when using a system theme, switch to a theme that matches your system’s color palette. ## Missing browser functionality¶ If you see an error like `No more handles because there is no underlying browser available`, install the `libwebkit2gtk` library. ## Theme parsing errors¶ If you get errors like `GTK-WARNING xxx:Theme parsing error`, try adjusting the GTK program style in your system settings: * Open **System Settings - > Appearance -> Program Style** (the exact location may vary by desktop environment). * Pick a style that works better with GTK apps. ## Gtk box gadget distribute error¶ If you see the error `gtk_box_gadget_distribute: assertion size 'size >= 0' failed in GtkScrollbar`, turn off GTK overlay scrolling: 1. Open the file `~/.config/gtk-3.0/settings.ini`. 2. Add or update this setting: [Settings] gtk-overlay-scrolling = false ## Disabling the AT SPI accessibility bridge¶ The AT-SPI accessibility bridge can sometimes cause crashes, especially on Linux with Cinnamon. To disable it: 1. Open a terminal and run: export NO_AT_BRIDGE=1 2. Make the change permanent: * Add the line to your shell configuration file (e.g., `~/.bashrc` or `~/.zshrc`): export NO_AT_BRIDGE=1 3. Restart your session to apply the change. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Troubleshooting-task-scheduler-issues/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * Troubleshooting task scheduler issues [ Troubleshooting task scheduler issues ](./) Table of contents * User Authentication and Corporate Security * Windows Task Scheduler * Excluding legacy Scheduler * Windows Task Scheduler - incorrect date format * Applicable to legacy Scheduler * MacOS * Unable to read or write to crontab * Tasks from password protected projects cannot be run * Console task execution without password interruptions * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * User Authentication and Corporate Security * Windows Task Scheduler * Excluding legacy Scheduler * Windows Task Scheduler - incorrect date format * Applicable to legacy Scheduler * MacOS * Unable to read or write to crontab * Tasks from password protected projects cannot be run * Console task execution without password interruptions 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. Troubleshooting # Troubleshooting task scheduler issues Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. ## User Authentication and Corporate Security¶ When you: * Enable enterprise security for database credentials. * Use mail server authentication to send data transfer results. These settings won’t work in scheduled tasks by default. You can switch to OS-specific encryption to fix this. This method doesn’t use the Master password, so it’s slightly less secure. Credentials are still encrypted but could be at risk if someone gets access to your computer. ![](../images/ug/Security-preferences.png) To enable OS-specific encryption: 1. Go to **Preferences - > General -> Security**. 2. Switch from **Master password** to **Integrated security**. Info For more details on configuring security, see [Security](../Security/). ## Windows Task Scheduler¶ There are two implementations of the Windows scheduler present: 1. CLI-based (**Legacy**): uses `schtasks.exe` to communicate with the scheduler; sensitive to locale-dependent data, such as Unicode names and date-time format. 2. COM-based (**New**): uses COM API to communicate with the scheduler; more flexible and provides more features than the CLI version. COM-based implementation is used by default, starting from the 21.1 version of DBeaver EE. ### Excluding legacy Scheduler¶ If you encounter an error in Windows which contains the following text: `com.sun.jna.platform.win32.COM.COMException`, do the following: 1. Open the file `dbeaver.ini`. Tip Detailed instructions on finding `dbeaver.ini` are available in [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). 2. Place the line `-Ddbeaver.scheduler.windows.legacy=true` below the `-vmargs` line. ### Windows Task Scheduler - incorrect date format¶ #### Applicable to legacy Scheduler¶ If you encounter an error in Windows which looks like this: `ERROR: Invalid Start Date (Date should be in %some_format% format).` do the following: 1. Open the file `dbeaver.ini` in the directory with your DBeaver installation 2. Place the line `-Ddbeaver.scheduler.windows.dateFormat=%some_format%` (where %some_format% is a format from the error message) below the `-vmargs` line. This flag is available starting from the 7.3.4 EA version of DBeaverEnterprise and might be removed in the future. ## MacOS¶ ### Unable to read or write to crontab¶ When scheduling tasks on macOS 10.15 or newer versions, the OS will prompt you to elevate DBeaver's permissions to administer your computer. If you do not grant these permissions, DBeaver will fail to schedule your tasks with an error `Unable to read or write to crontab`. To bypass this, simply restart DBeaver and try to schedule the task again. The operating system will prompt you to elevate the permissions again. If macOS never prompted to do that in the first place, you could grant `Full disk access` permissions in the macOS settings. Here is how to do that: 1. Open `System Preferences` 2. Click on `Security & Privacy` 3. Choose the `Privacy` tab 4. Choose the `Full Disk Access` folder 5. Unlock the preferences lock to the bottom if it is locked 6. Click the + button 7. Select DBeaver in the file picker that opens 8. Click `Open` 9. Close the lock ## Tasks from password protected projects cannot be run¶ You need to pass a password for one or more projects via the command-line interface. To do so, you need to set the `dbeaver.project.password` parameter in [the external configuration file](../Admin-Variables/#declare-external-variables- in-a-file) like so: # You can specify a single password for all projects: dbeaver.project.password=p4$$w0rd # Otherwise, you can specify a list of passwords for given projects: dbeaver.project.password=@General:p4$$w0rd,@Other:12345 The syntax for a single entry is `@ : `; others are separated by the `,` symbol. Note `@` and `:` symbols are mandatory. ## Console task execution without password interruptions¶ For tasks executed in console mode, such as sending automated emails, consider enabling the Automation (console) setting. This setting allows for uninterrupted task performance, preventing continuous password prompts during operation. Only enable this on machines where task execution is critical and security can be controlled. Tip For setup and management details, see [Automation security](../Automation- Security/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/UI-Language/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * Interface language [ Interface language ](./) Table of contents * Changing interface language in preferences * Changing interface language in configuration file * Supported languages * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Changing interface language in preferences * Changing interface language in configuration file * Supported languages 1. [DBeaver](/docs/dbeaver) 2. DBeaver configuration # Interface language The interface language of DBeaver can be customized to suit your preferences. There are two methods to achieve this: ## Changing interface language in preferences¶ 1. Navigate to **Window - > Preferences -> User Interface**. ![](../images/ug/UI-Language-Preferences.png) 2. Choose your desired language from the drop-down menu. 3. Click the **Apply and Close** button to save your settings. **Note** : If DBeaver is installed in a directory without write permissions, you may not be able to change the language directly through the interface. If this occurs, please proceed to modify the configuration file as described below. ## Changing interface language in configuration file¶ 1. Locate the `dbeaver.ini` file. Tip Detailed instructions on finding `dbeaver.ini` are available in [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). 2. Using a text editor, open this file to make changes. 3. Insert the following lines above the `-vmargs` line: -nl XX Replace `XX` with the language code from the list below: ## Supported languages¶ Language | Code ---|--- **English** | `en` **Arabic** | `ar` **French** | `fr` **German** | `de` **Italian** | `it` **Japanese** | `jp` **Korean** | `ko` **Portuguese (BR)** | `pt_BR` **Romanian** | `ro` **Russian** | `ru` **Simplified Chinese** | `zh` **Spanish** | `es` **Traditional Chinese** | `tw` **Ukrainian** | `uk` Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Ultimate-Edition/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * Ultimate edition [ Ultimate edition ](./) Table of contents * Ultimate Edition features * Advanced Enterprise features in Ultimate Edition * Subscription model * Integrated database drivers * Cloud Explorer databases * Supported databases * Relational databases * Non-Relational databases * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Ultimate Edition features * Advanced Enterprise features in Ultimate Edition * Subscription model * Integrated database drivers * Cloud Explorer databases * Supported databases * Relational databases * Non-Relational databases 1. [DBeaver](/docs/dbeaver) 2. [About DBeaver](/docs/dbeaver/Enterprise-Edition) 3. Editions # Ultimate edition [DBeaver Ultimate Edition](https://dbeaver.com/dbeaver-ultimate/) is perfect for users who require a powerful set of tools for managing complex data environments and are also seeking enhanced cloud capabilities. This edition builds on the features of the Enterprise Edition by adding specialized tools for cloud database management and Kafka data streams. It offers seamless integration and efficient management of cloud data sources, making it an excellent choice for users who need to extend their data handling into the cloud. Note The DBeaver Ultimate Edition is designed for individual use only. ## Ultimate Edition features¶ The Ultimate Edition offering unique capabilities designed for complex, multi- platform data management tasks with a strong emphasis on enhanced cloud integration: * **Cloud Explorer** : A tool for managing and connecting cloud-hosted databases. [Learn more](../Cloud-Explorer/) It offers integration with various cloud services: * **Amazon Web Services** [Learn more](../AWS-Cloud-Explorer/) * **Google Cloud Platform** [Learn more](../Google-Cloud-Explorer/) * **Microsoft Azure** [Learn more](../Azure-Cloud-Explorer/) * **Cloud Storage support** : Enables file management within cloud environments of Amazon Web Services and Google Cloud Platform. [Learn more](../Cloud-Storage/) * **Kafka support** : Provides integration with Apache Kafka. ### Advanced Enterprise features in Ultimate Edition¶ In addition to its unique features, the Ultimate Edition utilizes all the advanced capabilities from the Enterprise Edition, including: * **Data visualization** * **Data filtering and sorting** : Provides tools to filter and sort data directly within the database interface. [Learn more](../Data-Filters/). * **Color coding and highlighting** : Simplifies data analysis by color-coding and highlighting table rows and fields based on conditions. [Learn more](../SQL-Code-Editor/). * **Functional panels** : Enhance data manipulation by offering additional space in the Data Editor for managing complex data types, accessible via tabs in a dedicated panel. [Learn more](../Panels/). * **Tableau integration** : Facilitates integration with Tableau for advanced data visualization and analysis. [Learn more](../Tableau-integration-in-DBeaver/). * **Query development** * **SQL Editor** : Provides code completion for easier writing, auto-formatting, spelling checks, and support for variables. [Learn more](../SQL-Editor/). * **Execution plan visualization** : Provides detailed visualizations of SQL execution plans. [Learn more](../Query-Execution-Plan/). * **Additional tools for query creation** : * **Visual Query Builder (VQB)** : Provides a graphical interface to construct SQL queries without writing code. [Learn more](../Visual-Query-Builder/). * **AI Assistant** : Integrates an AI Assistant and AI Chat to offer guidance and automation within the SQL Editor. [Learn more](../AI-Smart-Assistance/). * **SQL debugger** : Offers an SQL debugger specifically designed for PostgreSQL, aiding in query development and troubleshooting. [Learn more](../PGDebugger/) * **Administrative tasks** * **Reverse engineering (ERD)** : Provides capabilities for reverse engineering databases into entity-relationship diagrams. [Learn more](../ER-Diagrams/). * **Forward engineering** : * **Metadata editor** : Enables the management and editing of database metadata. [Learn more](../Database-Object-Editor/). * **Edit mode for ER-Diagrams** : Offers functionalities for editing entity-relationship diagrams to aid in database design. [Learn more](../Edit-mode/). * **Administrative tools** : * **Backup and Restore** : Offers functionalities for backing up and restoring databases, ensuring data safety. [Learn more](../Backup-Restore/). * **Analyze and vacuum** : Tools for optimizing database performance by analyzing and vacuuming database objects. * **Permission and user management** : Manages database permissions and user accounts. * **Schema comparison** : Provides tools for comparing database schemas either within the same database or across different databases. [Learn more](../Data-compare/). * **Data comparison** : Offers tools for comparing data across databases or within different parts of the same database. [Learn more](../Schema-compare/). * **Mock data generator** : Provides tools for generating mock data, useful for testing and development purposes. [Learn more](../Mock-Data-Generation-in-DBeaver/). * **Data migration** * **Export and Import from files** : Supports data export and import in up to 10 different file formats. [Learn more](../Data-transfer/). * **Direct transfer between databases** : Provides tools for efficient data migration directly between different databases or systems. [Learn more](../Data-migration/). * **Security** * **Database authentication** : Implements database authentication mechanisms to secure access. * **Master and Project Password** : * **Master password** : Enables the use of a master password to enhance security across the DBeaver. [Learn more](../Managing-Master-Password/). * **Project password** : Facilitates the use of project-specific password to secure projects. [Learn more](../Project-security/). * **Automation** * **Task manager** : A tool for managing and monitoring database tasks, enhancing productivity and organization. [Learn more](../Task-Management/). * **Task scheduler** : Allows for scheduling database tasks, automating routine operations. [Learn more](../Task-Scheduler/). * **Git integration** : Supports integration with Git for version control, and change tracking. [Learn more](../Project-team-work/). ### Subscription model¶ The DBeaver Ultimate Edition is offered as an annual subscription, which should be renewed to continue receiving updates and support. [Discover more about the DBeaver Ultimate Edition and subscribe](https://dbeaver.com/dbeaver-ultimate/). ### Integrated database drivers¶ The Ultimate Edition has a comprehensive set of JDBC drivers, offering connectivity to various databases without needing separate downloads and configurations. Additionally, a versatile ODBC driver is supported for broader database compatibility. Info For additional details on utilizing the ODBC driver, please consult the [ODBC- JDBC driver](../ODBC-JDBC-Driver/) article. This edition also includes the Cloud Explorer feature, which provides access to cloud databases such as those on Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. Cloud Explorer enables centralized authentication and automatic configuration, simplifying the management of cloud database connections. #### Cloud Explorer databases¶ For a list of supported databases, please refer to the [related section](../Cloud-Explorer/#supported-databases) in the Cloud Explorer guide. ### Supported databases¶ The Ultimate Edition provides support for a wide range of databases. Below are tables listing the databases available and specifying whether the Ultimate Edition offers enhanced features compared to the Community Edition. * Enhanced features may include additional metadata capabilities, such as the ability to manage and interact with specific database objects unique to certain systems. For instance, managing **Datashares** in Redshift or handling **Sequences** in Netezza. These features also cover various advanced authentication methods, and numerous other functionalities designed to improve security and data management. #### Relational databases¶ Database name | Enhanced features* compared to the Community Edition | Available through Cloud Explorer ---|---|--- **Altibase** | - | - **Apache Arrow** | Not available in Community Edition | - **Apache Calcite Avatica** | ✓ | - **Apache Kylin** | - | - **Aurora DSQL** | Not available in Community Edition | ✓ **Azure SQL Server** | ✓ | ✓ **Babelfish via TDS (beta)** | ✓ | - **CUBRID** | ✓ | - **Cache** | - | - [**ClickHouse**](../Clickhouse/) | - | - **CloudberryDB** | - | - [**ClickHouse (Legacy)**](../Clickhouse/) | ✓ | - [**CloudSQL - MySQL**](../Database-driver-MySQL-on-Google-Cloud/) | Not available in Community Edition | ✓ [**CloudSQL - PostgreSQL**](../Database-driver-PostgreSQL-on-Google-Cloud/) | Not available in Community Edition | ✓ [**CloudSQL - SQL Server**](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) | Not available in Community Edition | ✓ **CockroachDB** | - | - **CrateDB** | - | - **CrateDB (Legacy)** | - | - [**Databricks**](../Database-driver-Databricks/) | ✓ | - **Dameng** | - | - [**Db2 for IBM i**](../Database-driver-IBM-Db2/) | ✓ | - [**Db2 for LUW**](../Database-driver-IBM-Db2/) | - | - [**Db2 for z/OS**](../Database-driver-IBM-Db2/) | ✓ | - **Denodo 8** | - | - **Derby Embedded** | - | - **Derby Server** | - | - **Dremio** | - | - **DuckDB** | - | - **EDB** | ✓ | - **Exasol** | ✓ | - **Firebird** | Not available in Community Edition | - **Firebird** | ✓ | - **Fujitsu Enterprise Postgres** | Not available in Community Edition | - **GaussDB** | - | - [**Google AlloyDB**](../Database-driver-AlloyDB-for-PostgreSQL/) | Not available in Community Edition | ✓ **Google Cloud Spanner** | ✓ | ✓ [**Greenplum**](../Database-driver-Greenplum/) | ✓ | - **Greengage** | Not available in Community Edition | - **H2 Embedded** | ✓ | - **H2 Embedded V.2** | - | - **H2 Server** | ✓ | - **H2GIS Embedded** | - | - **H2GIS Server** | - | - **HANA** | ✓ | - **HSQL Embedded** | - | - **HSQL Server** | - | - **Informix** | ✓ | - **Ingres** | - | - **InterSystems IRIS** | - | - **JDBCX** | - | - **Jennifer** | - | - **MS Access (UCanAccess)** | - | - [**MariaDB**](../Database-driver-MariaDB/) | ✓ | - **Materialize** | - | - **MaxDB** | - | - **Mimer SQL** | - | - **MonetDB** | - | - [**MySQL**](../Database-driver-MySQL/) | ✓ | ✓ [**MySQL 5 (Legacy)**](../Database-driver-MySQL/) | ✓ | - **NDB Cluster** | - | - **NetSuite** | Not available in Community Edition | - [**Netezza**](../Database-driver-Netezza/) | ✓ | - **NuoDB** | - | - **ODBC** | Not available in Community Edition | - **OceanBase** | - | - **Ocient** | - | - **OmniSci (formerly MapD)** | - | - **OpenEdge** | - | - **OpenSearch** | ✓ | - [**Oracle**](../Oracle/) | ✓ | ✓ **Pervasive SQL** | - | - [**PostgreSQL**](../Database-driver-PostgreSQL/) | ✓ | ✓ **PrestoDB** | - | - **PrestoSQL** | - | - **Raima** | Not available in Community Edition | - [**Redshift**](../Database-driver-Amazon-Redshift/) | ✓ | - [**Redshift Serverless**](../Database-driver-Amazon-Redshift/) | ✓ | ✓ **RisingWave** | - | - **SAP ASE jConnect** | - | - [**SQL Server**](../Database-driver-Microsoft-SQL-Server/) | ✓ | ✓ [**SQL Server (Old driver, jTDS)**](../Database-driver-Microsoft-SQL-Server/) | ✓ | - [**SQLite**](../Database-driver-SQLite/) | ✓ | - [**SQLite Crypt**](../Database-driver-SQLite/) | Not available in Community Edition | - **SQream DB** | - | - [**Salesforce**](../Database-driver-Salesforce/) | Not available in Community Edition | - **Salesforce Data Cloud** | ✓ | - **SingleStore** | ✓ | - [**Snowflake**](../Snowflake/) | ✓ | - **StarRocks** | - | - **Sybase jConnect** | ✓ | - **Sybase jTDS** | ✓ | - [**Teradata**](../Database-driver-Teradata/) | ✓ | - **TiDB** | - | - [**Trino**](../Database-driver-Trino/) | - | - **Vertica** | ✓ | - **Virtuoso** | - | - [**Yellowbrick**](../Database-driver-Yellowbrick/) | - | - **YugabyteDB** | - | - #### Non-Relational databases¶ Database name | Enhanced features* compared to the Community Edition | Available through Cloud Explorer ---|---|--- **Apache Drill** | ✓ | - [**Apache Hive**](../Apache-Hive/) | ✓ | - **Apache Ignite** | - | - **Apache Kyuubi** | - | - **Apache Phoenix** | - | - **Apache Spark** | - | - [**Athena**](../Database-driver-Amazon-Athena/) | ✓ | ✓ **Azure Cosmos DB for Cassandra** | Not available in Community Edition | ✓ [**Azure Cosmos DB for MongoDB**](../Database-driver-CosmosDB/) | Not available in Community Edition | ✓ [**Azure Cosmos DB for NoSQL**](../Database-driver-Azure-CosmosDB-for-NoSQL/) | Not available in Community Edition | ✓ [**Cassandra**](../Cassandra/) | Not available in Community Edition | - **Cloudera Impala** | - | - **CouchDB** | Not available in Community Edition | - [**Couchbase**](../Couchbase/) | Not available in Community Edition | - [**Couchbase 5+**](../Couchbase/) | Not available in Community Edition | - [**CSV**](../Database-driver-CSV/) | + | - **DBF** | - | - [**DocumentDB**](../AWS-DocumentDB/) | Not available in Community Edition | ✓ [**DynamoDB**](../AWS-DynamoDB/) | Not available in Community Edition | ✓ **Elasticsearch** | ✓ | - [**Firestore**](../Database-driver-Firestore/) | Not available in Community Edition | ✓ **Gemfire XD** | - | - [**Google BigQuery**](../Database-driver-BigQuery/) | ✓ | ✓ [**Google Cloud Bigtable**](../Google-Bigtable/) | Not available in Community Edition | ✓ [**InfluxDB**](../InfluxDB/) | Not available in Community Edition | - [**InfluxDB 2**](../InfluxDB/) | Not available in Community Edition | - [**InfluxDB 3**](../InfluxDB/) | Not available in Community Edition | - **Kafka (ksqlDB)** | Not available in Community Edition | - [**Keyspaces**](../AWS-Keyspaces/) | Not available in Community Edition | ✓ **Machbase** | - | - [**MongoDB**](../MongoDB/) | Not available in Community Edition | - [**Neo4j**](../Database-driver-Neo4j/) | Not available in Community Edition | - [**Neptune**](../Database-driver-Neptune/) | Not available in Community Edition | ✓ **Open Distro Elasticsearch** | ✓ | - **OrientDB** | - | - [**Parquet**](../Database-driver-Parquet/) | Not available in Community Edition | - [**Redis**](../Redis/) | Not available in Community Edition | - **ScyllaDB** | Not available in Community Edition | - **SnappyData** | - | - **Solr** | - | - **TDengine** | ✓ | - **TDengine Cloud** | ✓ | - **TimescaleDB** | - | - [**Timestream**](../Database-driver-Amazon-Timestream/) | Not available in Community Edition | ✓ [**XLSX**](../Database-driver-XLSX/) | Not available in Community Edition | - **Yugabyte CQL** | Not available in Community Edition | - Back to top --- # Source: https://dbeaver.com/docs/dbeaver/User-Interface-Themes/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * User interface [ User interface ](./) Table of contents * Change the DBeaver theme * Managing the High Contrast theme in Windows * Activation of High Contrast theme * Deactivation of High Contrast theme * High Contrast theme switching limitations * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Change the DBeaver theme * Managing the High Contrast theme in Windows * Activation of High Contrast theme * Deactivation of High Contrast theme * High Contrast theme switching limitations 1. [DBeaver](/docs/dbeaver) 2. DBeaver configuration # User interface The interface themes governs the look and feel of the user interface's windows, dialogs, buttons, and all other visual components. By default, DBeaver is configured to use the **Light** theme. ## Change the DBeaver theme¶ 1. Go to **Window** -> **Preferences** -> **User Interface** -> **Appearance**. 2. Select from the following available themes: * **Light** * **Dark** * **Classic** Note To fully apply the selected theme, you must restart DBeaver. ## Managing the High Contrast theme in Windows¶ Windows users have the additional option of using **High Contrast** themes. This section provides details on how DBeaver interacts with these themes. ### Activation of High Contrast theme¶ When the **High Contrast** theme is activated in Windows, DBeaver automatically switches its theme to **High Contrast**. If DBeaver is already running when the system theme changes, a notification will appear suggesting a restart for the theme to apply correctly. ### Deactivation of High Contrast theme¶ If you deactivate the **High Contrast** theme in Windows, it will automatically be removed from DBeaver's list of available themes after the restart. **Note** : After disabling the **High Contrast** theme in Windows, DBeaver will revert to the theme that was previously selected. ### High Contrast theme switching limitations¶ The theme switcher in DBeaver is disabled when the **High Contrast** theme is active in Windows. You cannot switch to a **non-High Contrast** theme in DBeaver unless you disable the **High Contrast** theme in Windows. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Using-Liquibase-in-DBeaver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * Liquibase support [ Liquibase support ](./) Table of contents * Supported Databases * Steps to add a Liquibase Pro key * Add Liquibase Pro key via the UI * Enable PRO objects in schema compare * Object types being compared by LiquibasePRO * Additional Resources * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Supported Databases * Steps to add a Liquibase Pro key * Add Liquibase Pro key via the UI * Enable PRO objects in schema compare * Object types being compared by LiquibasePRO * Additional Resources 1. [DBeaver](/docs/dbeaver) 2. [Data transfer and schema compare](/docs/dbeaver/Data-transfer) 3. Schema compare # Liquibase support Note This feature is available in [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team- edition/) editions only. DBeaver integrates with Liquibase, an open-source tool that helps you track, manage, and apply database changes. With DBeaver's Liquibase support, you can efficiently manage your database changes. You can create and manage Liquibase [changelogs](../Schema- compare/#liquibase-changelog-generation) directly in DBeaver, making tracking and applying database changes easier. With the [Liquibase PRO key](../Schema- compare/#using-schema-compare-with-liquibase-pro-key), you can also use DBeaver's [Schema Compare](../Schema-compare/) feature for an enhanced comparison of database schemas. ## Supported Databases¶ Liquibase works with a variety of databases. The specific databases that DBeaver supports are listed in the [Schema Compare](../Schema- compare/#databases-supporting-schema-comparison) article. ## Steps to add a Liquibase Pro key¶ 1. Locate your `dbeaver.ini` file. For help finding `dbeaver.ini`, see [our article](../Configuration-files-in-DBeaver/#how-to-locate-the-dbeaver-ini). 2. Edit the file: * Find the `-vmargs` command. * Add a new line after it: -Dliquibase.license.key=yourKey Example: `-Dliquibase.license.key=ABwwGgQU...` 3. Restart DBeaver. 4. Open DBeaver, then open the **Schema Compare** tool. The key will be verified automatically. Note If you add the key in both `dbeaver.ini` and through the Import Key dialog, the `.ini` file key takes priority. ## Add Liquibase Pro key via the UI¶ You can also add the key directly in the UI: 1. Go to **Preferences** > **Editors** > **Schema Compare**. 2. Use the **Import Liquibase Pro Key** button to open the import key dialog. ![Schema compare import button](../images/ug/tools/schema_compare/schema_compare_import_LB_key_button.png) * **Paste** the key manually in the **Liquibase Key** field. * Use **Load** to import the key from a file. * Click **Check Key State** to verify the key. Results appear in the **Messages** field. ![Invalid key state](../images/ug/tools/schema_compare/schema_compare_import_LB_dialog_invalid_state.png) ![Valid key state](../images/ug/tools/schema_compare/schema_compare_import_LB_dialog_valid_state.png) ## Enable PRO objects in schema compare¶ If the license key is valid, the **Object types** dialog includes Pro objects. Tip If Pro objects don’t appear in the changelog, check the logs. The key might be invalid or expired. ![](../images/ug/tools/schema_compare/schema_compare_settings_PRO_types.png) ## Object types being compared by LiquibasePRO¶ * Check Constraints * Procedures * Functions * Triggers * Synonyms (Oracle) * Package with the body (Oracle) ## Additional Resources¶ For more information on Liquibase, refer to these resources: * [How Liquibase Works](https://www.liquibase.com/how-liquibase-works) * [Fundamentals of Liquibase](https://medium.com/@sahanats11/fundamentals-of-liquibase-9be58bc124a6) * [Core Liquibase Usage Concepts](https://www.liquibase.org/get-started/core-usage) * [Liquibase Quickstart](https://www.liquibase.org/get-started/quickstart) * [Evolving Your Database Schema Safely with Liquibase](https://www.baeldung.com/liquibase-refactor-schema-of-java-app) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Utilizing-Foreign-Keys/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * Utilizing foreign keys [ Utilizing foreign keys ](./) Table of contents * Create * Saving changes * Modify * Delete * Restrictions * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Create * Saving changes * Modify * Delete * Restrictions 1. [DBeaver](/docs/dbeaver) 2. [Tutorials](/docs/dbeaver/New-Table-Creation) 3. Table Creation # Utilizing foreign keys This article provides a comprehensive guide on the creation and management of Foreign Keys within DBeaver. While not always necessary, foreign keys can be used to establish relationships between [tables](../New-Table-Creation/), which can help maintain data consistency and integrity. In DBeaver, the creation of a foreign key involves referencing a [unique key](../Implementing-Constraints/#unique-key) in another table. This process forms a relationship that is essential for maintaining data integrity. Additionally, DBeaver allows you to define specific rules for the behavior of foreign keys when deleting or updating rows in the main table. This guide will detail the steps involved in creating, modifying, and deleting foreign keys. It will also explain how to set up rules for their behavior. It is important to note that the management of foreign keys requires careful consideration due to their significant impact on data relationships. ## Create¶ Creating a new foreign key in DBeaver involves a series of steps that guide you through the process. 1. You can start the process of creating a new foreign key in three ways: 2. Using the **[Properties editor](../Properties-Editor/)** : Open the Properties Editor and navigate to the **Foreign Keys** tab of the corresponding table. ![](../images/tutorial_images/11_Create_New_FK.png) * Using the **[Database Navigator](../Database-Navigator/)** : Navigate to the database where the table you want to add a foreign key to is located. Find and select the table for which you want to create a new foreign key. Within the selected table, you'll find a folder named **Foreign Keys**. * Additionally, to create a new foreign key, you can utilize the **Create New Foreign Key** button ![](../images/tutorial_images/11e_FK_Button.png) located at the bottom of the **Properties editor**. * Depending on the method you chose in step 1, either right-click on the window (in the **Properties Editor**) or within the **Foreign Keys** folder (in the **Database Navigator**), and select **Create New Foreign Key**. If you're using the third method, simply click the **Create New Foreign Key** button. This will open a new window where you'll be able to customize the foreign key's settings to suit your needs. ![](../images/tutorial_images/11a_FK_parameters.png) Field | Description ---|--- **Reference table** | Select the table that the foreign key references. **Unique Key** | Choose the unique key in the reference table that the foreign key will point to. **Columns** | Select the columns in your table that will become the foreign key. You can start creating a foreign key even if the specified column does not exist. In such a situation, you can open the dropdown menu in the **column** field and select ``. **Deferrable** | Specify whether the enforcement of the foreign key constraint can be deferred until the end of the transaction. **Deferred** | If the foreign key is deferrable, this option sets whether the constraint is deferred by default. **On delete/on update:** | Set the actions that will be taken when the referenced data is deleted or updated. The options are **No Action** , **Cascade** , **Restrict** , **Set NULL** , and **Set Default**. **\- No Action** | This option means that if the referenced data is deleted or updated, no action will be taken. However, if such a change would result in a violation of the foreign key constraint, the change will be disallowed. **\- Cascade** | If the referenced data is deleted or updated, the same action will be applied to all rows holding a foreign key that points to that data. For example, if a row in the referenced table is deleted, all rows in the table with the foreign key that point to that row will also be deleted. **\- Restrict** | This option disallows the deletion or updating of referenced data. If any foreign keys reference the data, the change will be disallowed. **\- Set Null** | If the referenced data is deleted or updated, all foreign keys that reference it will be set to `NULL`. **\- Set Default** | If the referenced data is deleted or updated, all foreign keys that reference it will be set to their default values. If no default value is specified, this option behaves the same as **No Action**. **Column options...** | Active only for new column. Opens a window where you can configure the new column. 1. After hitting **OK** , a window displaying the newly created foreign key will appear. ![](../images/tutorial_images/11b_FK_After_Saving.png) ### Saving changes¶ Once you have configured the foreign key properties, it is essential to save these changes to the database. Until you commit your modifications, the new foreign key will only exist within DBeaver and will not be added to the actual database table. Here are three options for committing the changes: * Click on **File** -> **Save** -> **Persist**. * Select the desired table in the **Database Navigator** and press `Ctrl+S` (or `CMD+S` for Mac OS), choose **Persist** to save the changes. * Utilize the **Save** button ![](../images/tutorial_images/10b_SaveButton.png) located at the bottom of the **Properties editor** and press **Persist** to save the changes. ## Modify¶ Over time, you may need to adjust the properties of your foreign keys. This could involve renaming a foreign key, changing its referenced table or unique key, adjusting its columns, or updating its rules for deletion or update. DBeaver allows you to make these modifications as needed. Here's how: * **Properties Editor** : Open the Properties Editor by double-clicking on the table name. Within the selected table, you'll find a folder named **Foreign Keys**. Right-click on the foreign key you want to modify and select **View Foreign Key**. * **Database Navigator** : In the Database Navigator, select the appropriate database and table. Within the selected table, you'll find a folder named **Foreign Keys**. Right-click the foreign key and select **View Foreign Key**. * **Bottom Menu** : In the **Properties Editor** interface, use the **View Foreign Key** button ![](../images/tutorial_images/View_column_button.png) to open the properties of the selected foreign key in the **Editor panel**. ![](../images/tutorial_images/11d_FK_Properties.png) ## Delete¶ 1. You can delete a foreign key either through the **Properties Editor** or the **Database Navigator** : 2. Using the **Properties Editor** : Open the Properties Editor, navigate to the **Foreign Keys** tab of the corresponding table, and find the foreign key you want to delete. ![](../images/tutorial_images/11c_Delete_FK.png) * Using the **Database Navigator** : Navigate to the database where the table with the foreign key is located. Open the **Foreign Keys** folder, and find the foreign key you want to delete. * To delete a foreign key, right-click on the key's name and select **Delete** , or you can select the necessary foreign key and press the `Delete` key, or **Delete button** ![](../images/tutorial_images/Delete_button.png) (in the **Bottom Menu** of the **Properties Editor**). * A confirmation dialog will appear, asking you to confirm the deletion. Before proceeding, ensure that you've selected the correct foreign key for deletion. * After confirming the deletion, you'll need to persist the changes to apply them to the database. ## Restrictions¶ * **Referential Integrity** : Foreign keys enforce referential integrity. The values in the foreign key column must match those in the referenced primary key. * **No Circular References** : Circular foreign key references are not permitted in most databases where two or more tables refer to each other. * **Delete and Update Operations** : Deleting or updating rows from the referenced table can be complicated because of the need to preserve referential integrity. * **Schema Modifications** : Changes to the schema of a table (like altering data types or column deletions) can be restricted if a foreign key references the table. **Further Reading:** [New Table Creation](../New-Table-Creation/) | [Creating columns](../Creating-columns/) | [Implementing Constraints](../Implementing-Constraints/) | Utilizing foreign keys | [Creating indexes](../Creating-Indexes/) | [Incorporating triggers](../Incorporating-Triggers/) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Value-Panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * Value Panel [ Value Panel ](./) Table of contents * Toolbar actions * Working with specialized data formats * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Toolbar actions * Working with specialized data formats 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. [Viewing and editing data](/docs/dbeaver/Data-View-and-Format) 4. Panels # Value Panel The **Value viewer** panel lets you view and edit cell values directly in the [Data Editor](../Data-Editor/). It’s especially useful for working with long text, `JSON`, binary data, and other complex types. ![](../images/ug/Value-Viewer-Panel.png) The panel opens automatically when you press `F7` or click **Panels - > Value viewer** on the bottom toolbar. ## Toolbar actions¶ Its toolbar includes common buttons available for all data types: Button | Name | Description ---|---|--- ![](../images/ug/Apply-cell-value-button.png) | **Apply cell changes** | Apply the changes made in the Value viewer to the data table. ![](../images/ug/Auto-apply-value-button.png) | **Auto-apply value** | Automatically update the data table when you edit a value in the viewer. Changes appear immediately. ![](../images/ug/XML_editor_load_from_file_icon.png) | **Load from file** | Load data from a local file. ![](../images/ug/XML_editor_save_to_file_icon.png) | **Save to file** | Save the current content to a local file. ![](../images/ug/XML_editor_icon.png) | **Content viewer settings** | Switch between Binary, XML, Text, and JSON formats. ![](../images/ug/Open-in-external-editor-button.png) | **Open in external editor** | Open the content in an external editor for advanced editing. Note These buttons only save changes in the viewer, not in the database. To save data to the database, use **Save** (![](../images/ug/Save-button-Data- Editor.png)) on the bottom toolbar of the [Data editor](../Data-Editor/). Additional toolbar buttons and context menu options appear depending on the data type, such as `Array`, `JSON`, `datetime`, or `Binary`. ## Working with specialized data formats¶ The **Value viewer** supports several data formats and provides dedicated tools for viewing and editing each of them. Data type | Description ---|--- [XML and JSON data](../Working-with-XML-and-JSON/) | Edit and format structured text data using syntax highlighting and auto formatting. [Dictionary data](../Working-with-Dictionary-Data/) | Explore and manage reference or metadata tables used as lookup dictionaries. [Spatial (GIS) data](../Working-with-Spatial-GIS-data/) | Visualize and analyze geometric or geographic data on an interactive map. Info Each data type opens in the **Value viewer** with its own tools for formatting, visualization, and export. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Variables-panel/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * Variables panel [ Variables panel ](./) Table of contents * Manipulating variables * Moving a panel * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Manipulating variables * Moving a panel 1. [DBeaver](/docs/dbeaver) 2. [SQL Editor](/docs/dbeaver/SQL-Editor) 3. Query development and assistance # Variables panel You can see all of the currently assigned local variables for SQL Editor. You need to click a "Show SQL variables" button in the SQL editor. A new tab alongside Output and Execution log panels will be opened with a list of assigned variables. On this panel, you can also show assigned parameters by clicking the corresponding button. (Note: toolbar is customizable. See [Toolbar Customization](../Toolbar-Customization/#top-toolbar-customization)) ![](../images/ug/show-parameters.png) Tip Read more about pre-configured variables in our [article](../Pre-configured- Variables/) ## Manipulating variables¶ You can change values for the current variable using the variables tab. Simply click on a variable's row and edit its value in the window below. To delete or add a variable or parameter, you can use a corresponding button. Instead of typing @set or @unset, you can use these buttons in the script. If you have a long list of variables, you can click a magnifying glass to initiate a search bar. Start typing either a variable's name or its value to filter the list. ## Moving a panel¶ Variables panel is always connected to output and execution log panels, but this group of tabs can be configured to be shown either at the right side of the editor or at the bottom alongside the results panel. By default, the panels are shown on the right side. To change their location you need to either check or uncheck `Show panels in result tabs` in the context menu. ![](../images/ug/show-panels-in-result-tab.png) Back to top --- # Source: https://dbeaver.com/docs/dbeaver/View-and-Editor-Actions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * View and editor actions [ View and editor actions ](./) Table of contents * Available actions * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Available actions 1. [DBeaver](/docs/dbeaver) 2. [AI](/docs/dbeaver/AI-Smart-Assistance) 3. [Features](/docs/dbeaver/AI-chat) 4. AI functions # View and editor actions ![tag-outline](/docs/includes/icons/tag-outline.svg)Since 25.3 This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. AI view and editor actions help you navigate the DBeaver interface through natural language. When your request describes an action, DBeaver opens the editor or view that matches what you asked. To use the actions: 1. Open [AI chat](../AI-chat/) on the connection you want to work with 2. Write a prompt that describes the view, editor, or panel you want to open or close Note To use an action, make sure it’s turned on in the [Functions settings](../AI-Assistance-settings/#functions). 3. AI reads your request and opens the matching editor or view in the workspace ## Available actions¶ Use these actions to open editors, switch views, manage workspace panels, or create new connections. Just describe what you want in AI chat, and the assistant performs the action for you. Action | What it does | Example ---|---|--- Create new connection | Opens the [New Connection](../Create-Connection/) wizard with pre-filled settings | `"connect to a PostgreSQL database at host 1213, database name stage"` Open database object editor | Opens a [Database object editor](../Database-Object-Editor/) for a table/view | `"open orders data editor"` Open SQL Editor | Opens a new [SQL Editor](../SQL-Editor/) tab | `"open sql editor for sales"` Open view | Opens a view (e.g. [Query manager](../Query-Manager/)) | `"show query manager"` Close editor | Closes the selected editor | `"close artist table editor"` Close view | Closes a selected view panel | `"close bookmarks"` Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Virtual-Keys/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * Virtual keys [ Virtual keys ](./) Table of contents * Virtual key management * Accessing the virtual key configuration window * Creating a virtual unique key * Error handling during data modification * Creating a virtual foreign key * Editing virtual keys * Settings for missing keys * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Virtual key management * Accessing the virtual key configuration window * Creating a virtual unique key * Error handling during data modification * Creating a virtual foreign key * Editing virtual keys * Settings for missing keys 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Virtual entities # Virtual keys The virtual key feature in DBeaver allows you to save changes to tables that do not have a primary key or unique index. You can define a virtual key, which is a set of columns that form a unique combination of values. This ensures each row can be uniquely identified, allowing you to save changes to the table. Note Virtual keys exist only in DBeaver, not in the database itself. You can define these keys even if your database does not support them. **Tip** : All virtual entities are stored in the `data-sources.json` file. For more information, refer to the [Configuration Files](../Configuration-files-in-DBeaver/#other- configuration-files) article. ## Virtual key management¶ Use virtual keys to handle data updates and relationships in tables that don't have physical primary or foreign keys. ### Accessing the virtual key configuration window¶ You can access the settings for configuring virtual keys through two different methods: 1. **[Properties Editor](../Properties-Editor/)** : 1. Navigate to the **Properties Editor**. 2. Select the **Virtual** tab from the **Tabbed editors**. 3. In the **Virtual Foreign/Unique Keys** section, click **Add** 4. Configure the options ![](../images/ug/virtual-entities/virtual-entities-in-properties-editor.png) 2. **[Data Editor](../Data-Editor/)** : 1. Right-click inside the **Data Editor**. 2. Select **Logical structure - > Define virtual unique key/Add virtual foreign key** 3. Configure the options ![](../images/ug/virtual-entities/virtual-entities-in-data-editor.png) Note When creating a connection in the [Connection Details](../Create- Connection/#connection-details), ensure the checkbox for **Show virtual model Editor** is selected to access virtual key features. ### Creating a virtual unique key¶ Inserting new rows into a table that do not have a primary key or unique index can generally be completed without issues, but updating existing data can be tricky. A virtual primary key helps you update data by acting as a unique identifier for rows in tables without a physical primary key. 1. Navigate to the **Virtual Unique Key** settings. 2. Configure the options: ![](../images/ug/virtual-entities/creating-a-virtual-unique-key.png) Field/Checkbox | Description ---|--- **Table** | Automatically filled with the name of the table being modified. **Name** | Enter a name for the virtual key. **Use All Columns** | Check this to include all columns from the table in the virtual unique key. **Columns List** | Displays columns available for selection. **Select All** | Button to quickly select all columns in the **Columns List**. Important Be careful with the **Use All Columns** option. It may cause changes in multiple rows if the columns do not uniquely identify each row. 3. Click **OK** to save the virtual key. #### Error handling during data modification¶ If you begin modifying data in a table that lacks a primary or unique key, DBeaver will alert you with the following error message: ![](../images/ug/virtual-entities/no-unique-key-error-message.png) You can handle the error in one of two ways: * **Use All Columns** : Selecting this option immediately treats all columns as a virtual key. Important Use this option carefully, as it may cause changes in multiple rows if the columns do not uniquely identify each row. * **Custom Unique Key** : Alternatively, you can create a more specific virtual unique key by choosing **Custom Unique Key**. For more information on creating a virtual unique key, refer to the Creating a virtual unique key section. ### Creating a virtual foreign key¶ Virtual foreign keys are useful in databases where physical foreign key constraints are not present. They allow you to define and enforce relationships between tables virtually, ensuring data integrity. 1. Navigate to the **Virtual Foreign Key** settings. 2. Click **Add** to start defining a new foreign key. 3. Define the foreign key details: ![](../images/ug/virtual-entities/creating-a-virtual-foreign-key.png) Field/Option | Description ---|--- **Table** | Automatically displays the name of the current table. **Reference table container** | Select the schema of the reference table. **Reference Table** | Choose a table to reference. Selecting a table updates the **Unique key** and **Columns** fields. **Unique key** | Displays keys available in the reference table. Select one that the foreign key will link to. **Columns** | Customize which columns in your table map to columns in the reference table. Options in this dropdown are based on the selected unique key. Select `` to create a new mapping or choose existing columns to modify their mapping. 4. Click **OK** to create the foreign key. Tip You can also create virtual foreign keys in the [Diagrams](../ER-Diagrams/) by dragging and dropping columns. This shows the foreign key connections between tables visually, making it easier to see how your database is structured. ### Editing virtual keys¶ To modify or delete existing virtual keys, follow these steps: 1. Access the Configuration Window as detailed in the section Accessing the virtual key configuration window. 2. Choose the virtual key you wish to modify. * To make changes, select **Edit** and adjust as needed. * To delete, choose **Remove**. Note Virtual foreign keys cannot be edited once created; they can only be removed if changes are needed. ## Settings for missing keys¶ To configure how DBeaver handles tables without unique keys, navigate to **Window - > Preferences -> Editors -> Data Editor**. Here are the options: Option | Description ---|--- **Use all table columns as a key upon saving** | Utilizes all columns as a unique key. **Disable data editing** | Prevents editing on tables without a unique key. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Virtual-column-expressions/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * Virtual columns [ Virtual columns ](./) Table of contents * How to use * Functions * math * geo * content * row * table * Editing virtual columns * Defining virtual keys * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How to use * Functions * math * geo * content * row * table * Editing virtual columns * Defining virtual keys 1. [DBeaver](/docs/dbeaver) 2. [Data Editor](/docs/dbeaver/Data-Editor) 3. Virtual entities # Virtual columns Virtual columns in DBeaver let you display calculated values in query results without changing the underlying database schema. They use an expression language based on the [Apache Commons JEXL](http://commons.apache.org/proper/commons-jexl/reference/syntax.html) engine, which supports JavaScript-like syntax, functions, and variables. Expressions are evaluated in real time when you view data. Note Virtual columns exist only inside DBeaver and are not saved in the database. ## How to use¶ You can access the settings for configuring virtual columns through two different methods: 1. **[Properties Editor](../Properties-Editor/)** : 1. Navigate to the **Properties Editor**. 2. Select the **Virtual** tab from the **Tabbed editors**. 3. In the **Virtual columns** section, click **Add** 4. Enter a name and an expression for the new column ![](../images/ug/virtual-entities/virtual-entities-in-properties-editor.png) 2. **[Data Editor](../Data-Editor/)** 1. Right-click inside the Data Editor 2. Select **Logical structure - > Add virtual column** 3. Enter a name and an expression ![](../images/ug/grid_virtual_column_create.png) Info Virtual columns are shown alongside other columns in the Data Editor. Their values are calculated dynamically based on your expression. ### Functions¶ Functions are grouped into namespaces. You can refer to the functions in the namespaces as variables - `nsName.functionName(parameters)`. #### math¶ You can access all math functions as `math.function(parameters)`. Info See the full list of supported math functions in the [Oracle documentation](https://docs.oracle.com/cd/E12839_01/apirefs.1111/e12048/functmath.htm). #### geo¶ Function | Parameters | Description ---|---|--- wktPoint | (`longitude`, `latitude`) | Produces WKT (geometry) point out of two coordinates. Default SRID is `4326`. wktPoint | (`longitude`, `latitude`, `srid`) | Produces WKT (geometry) point out of two coordinates and SRID #### content¶ If you have JSON or XML columns in your table, you can add a virtual column with an expression for these columns. Use `content.json()[parameter1][parameter2]` pattern to create expression for JSON column. Example content.json(column1)['glossary']['GlossDiv']['title'] Use `content.xml(columnName, "expression")` or `content.xml(columnName, "returnType", "expression")` patterns to create an expression for an XML column. The quotation is important for parsing processes. The `"expression"` parameter is an [XPath](https://en.wikipedia.org/wiki/XPath) query used to select data from the XML. XML expression can return types: \- `string` \- `number` \- `boolean` \- `node` \- `nodeset` All these types can be used without quotes in the return type parameter. `content.xml(columnName, "expression")` returns `string` by default. Example content.xml(column1, "nodeset", "/Employees/Employee[gender='Female']/name/text()") #### row¶ `row` is a map of all columns in the current row, where keys are column names and values are column values. Use quotes or backticks for names with spaces, punctuation, or digits. Example row['First Name'] + ' ' + row['Last Name'] You can also refer to columns without `row` if their names are simple (no spaces or special characters). Example FirstName + ' ' + LastName #### table¶ `table` contains metadata about the current table. Supports: * `name` * `schema` * `container` Example table.name ### Editing virtual columns¶ To modify or delete an existing virtual column: 1. Access the settings for configuring virtual columns. 2. Select the column you want to change. 3. To edit, click **Edit** and update the name or expression. 4. To delete, click **Remove**. Note Changes apply only in DBeaver and don’t affect the database schema. ### Defining virtual keys¶ In cases where a table lacks a unique key, DBeaver provides the functionality to define a virtual key. This feature allows the creation of a custom set of columns that act as a unique identifier for table rows, facilitating the saving of changes in the absence of traditional unique constraints. Info Refer to the [Virtual Keys](../Virtual-Keys/) documentation for additional details on configuring and using virtual keys. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Visual-Query-Builder/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * Visual query builder [ Visual query builder ](./) Table of contents * Getting started * Visual Query Builder interface * Executing queries * Query configuration * Tables * Columns * Selecting columns in the workspace * Using the Columns tab in the Query settings * Adding and removing columns * Adjusting column order * Aliases * Grouping and aggregation * Where condition * Adding and removing conditions * Joins * Modifying joins * Context menu * Joins tab * Sorting * Adding and removing sorting conditions * Miscellaneous * Disable Visual Query Builder * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Getting started * Visual Query Builder interface * Executing queries * Query configuration * Tables * Columns * Selecting columns in the workspace * Using the Columns tab in the Query settings * Adding and removing columns * Adjusting column order * Aliases * Grouping and aggregation * Where condition * Adding and removing conditions * Joins * Modifying joins * Context menu * Joins tab * Sorting * Adding and removing sorting conditions * Miscellaneous * Disable Visual Query Builder 1. [DBeaver](/docs/dbeaver) 2. SQL Editor # Visual query builder Note This feature is available in [Lite](../Lite-Edition/), [Enterprise](../Enterprise-Edition/), [Ultimate](../Ultimate-Edition/) and [Team](https://dbeaver.com/docs/team-edition/) editions only. The **Visual Query Builder** in DBeaver is a visual tool that helps you build and understand SQL queries in complex databases. It lets you work with your database in a visual way, making it easy to see how tables connect and how data flows between them. This tool is useful when you want to create queries without writing SQL code yourself. The Visual Query Builder in DBeaver automatically converts your visual selections into SQL scripts, making it easier to explore and work with your data. ## Getting started¶ To start using **Visual Query Builder** , click the **Builder** button in the SQL Editor for the desired database. ![](../images/visual_query_builder/vqb-getting-started.png) Tip You can switch between the **SQL Editor** and the **Visual Query Builder** easily. If you write a valid SQL query in the [SQL Editor](../SQL-Editor/), it will show up in the Visual Query Builder. The same way, any query you build visually will appear in the SQL Editor. ## Visual Query Builder interface¶ The **Visual Query Builder** interface consists of the following sections: * **Workspace** : This area displays all the tables, columns, and their relationships that you have added to your query. * **Palette** : The **Palette** shows tools to interact with tables, and the section below displays the tables you have already selected and moved into the **Visual Query Builder** workspace. * **Query settings** window: This section displays the **Query** settings, where you can configure columns, conditions, joins, sorting, and other settings related to your query. ![](../images/visual_query_builder/visual-query-builder-interface.png) ## Executing queries¶ The **Visual Query Builder** works in a similar way to the **SQL Editor** when you run queries. * Click the **Execute SQL statement** button ![](../images/visual_query_builder/query_builder_run_icon.png) to run your query. You will see the results in the same tab. * You can also use the **Execute SQL statement in new tab** button ![](../images/visual_query_builder/query_builder_run1_icon.png) to run the query and open the results in a new tab. You will find both buttons on the vertical toolbar of the **Visual Query Builder** , giving you easy ways to run your queries and view the results. Note The toolbar is customizable. For more information, see [Toolbar Customization](../Toolbar-Customization/). ## Query configuration¶ The **Visual Query Builder** allows you to easily add tables, set query conditions, and customize how your query results are displayed using the **Query settings** available at the bottom of the workspace. These settings provide options for filtering, sorting, selecting columns, and setting join conditions, giving you full control over your query results. To open/close the **Query settings** window, click the **QUERY** button ![](../images/visual_query_builder/query-button.png). Tip You can toggle the visibility of the generated SQL query text by using the **Show/hide generated SQL query text** button ![](../images/visual_query_builder/query_builder_run_icon.png) on the right side of the window or by pressing `Ctrl+B` (`⌃B` for macOS). Below are the sections explaining how to work with the **Visual Query Builder** capabilities in more detail: ### Tables¶ You can add tables to the **Visual Query Builder** workspace using one of the following methods: 1. **Drag-and-Drop** : Drag the tables from the [Database Navigator](../Database-Navigator/) into the **Visual Query Builder** workspace. 2. **Using the Palette** : * In the **Pallete** menu, select **Add Table** from the **Tools** section. * Click on the **Visual Query Builder** workspace and choose the necessary table. ### Columns¶ By default, all columns (`*`) from the tables you add are selected. To customize use the following methods: #### Selecting columns in the workspace¶ * Click the checkboxes next to the column names in the table within the **Visual Query Builder** workspace to include or exclude columns from your query. * The SQL script will update automatically in the SQL script area, reflecting your selections. ![](../images/visual_query_builder/selecting-columns-in-the-workspace.png) Tip Click **Hide unused columns** button (![](../images/visual_query_builder/hide- unused-columns.png)) in the toolbar to collapse columns you’re not using. Keys stay visible even when this option is on. #### Using the Columns tab in the Query settings¶ * Select the **Columns** tab in the **Query settings**. In this tab, you can specify details related to the columns: Option | Description ---|--- **Column** | Select the desired column for your `SELECT` statement from the dropdown list. **Alias** | Provide a custom name for the column. **Grouping** | Define grouping for aggregated data. **Aggregation** | Select an aggregation function (e.g., `COUNT`, `AVG`, `MAX`, `MIN`, `SUM`) to process the selected data. ##### Adding and removing columns¶ * **Adding a Column** : Press the **Add** button ![](../images/visual_query_builder/query_builder_add_icon.png). A new column will be added to the query. Click on the first cell in the **Column or Expression** column and select a column from the dropdown list that appears. ![](../images/visual_query_builder/using-the-columns-tab-in-the-query- settings.png) * **Removing a Column** : To remove a column, click on the row containing its name and press the **Remove** button ![](../images/visual_query_builder/query_builder_remove_icon.png). ##### Adjusting column order¶ Use the **Move Up/Down** buttons ![](../images/visual_query_builder/query_builder_move_icon.png) to change the display order of columns in the result table. This will adjust the sequence in which the columns appear in your query. ##### Aliases¶ You can set a user-friendly name for your columns by clicking on a cell in the **Alias** column and entering the desired name. This alias will be reflected in the SQL script area and the final query result. ##### Grouping and aggregation¶ * If you want to apply a grouping condition, click the checkbox in the **Grouping** column row. This action will update your expression automatically. Other columns will become aggregated, and if there are no other columns, a `COUNT(*)` expression will be added. * You can select different aggregation functions from the dropdown list or manually enter your preferred function in the cell. Tip When you remove columns, they are also removed from the grouping expression. Any newly added columns will be automatically included in the grouping expression. ### Where condition¶ You can add conditional expressions using the **Where** tab, which allows you to manage query conditions by filtering your query results. Select the **Where** tab in the **Query settings**. In this tab, you can specify details related to the columns: Setting | Description ---|--- **Left Operand** | Defines the left operand of the conditional expression. This can be a column or a numeric value. **Operation** | Specifies the comparison rule (e.g., `=`, `>`, `LIKE`) to apply between the left and right operands. **Right Operand** | Defines the right operand of the expression, which can be a column, numeric value, or string. ![](../images/visual_query_builder/vqb-conditions.png) #### Adding and removing conditions¶ * **Adding a conditional expression** : Click the **Add** button ![](../images/visual_query_builder/query_builder_add_icon.png) on the right side of the tab. This action will create a new condition row, and a default `WHERE` clause will be automatically added to the SQL script area. * **Removing a conditional expression** : To remove an existing condition, select the row containing the condition you wish to delete and click the **Remove** button ![](../images/visual_query_builder/query_builder_remove_icon.png) on the right side of the tab. ### Joins¶ When you add a table to the **Visual Query Builder** workspace, the joins are created automatically based on existing relationships: * **Automatic Joins** : If the table you add has an existing relationship with one or more tables already in the workspace, the join will be displayed automatically. * **Inner join** behavior: If the table does not have any existing relationship with the tables already in the workspace, the system will create a `SIMPLE JOIN` with the first table you added to the workspace. Tip You can disable automatic joins based on foreign keys in the Miscellaneous tab by unchecking the **Auto-create joins according to foreign keys** option. For more information, see Miscellaneous section. #### Modifying joins¶ To modify joins in the **Visual Query Builder** , use either the **context menu** or the **Joins tab**. ##### Context menu¶ Right-click on the connection line between tables in the workspace to open a context menu. You’ll see join options labeled with their types (`Left Join`, `Right Join`, `Inner Join`, or `Full outer Join`). For more join options, use the Joins tab. ![](../images/visual_query_builder/vqb-joins-in-context-menu.png) ##### Joins tab¶ Open the **Joins** tab in the **Query settings** to manage and adjust join settings for all tables in the workspace. In this tab, you can work with the following options: Options | Icon | Description ---|---|--- **Table/Conditions** | | Displays the tables involved in the join along with the join conditions. **Type** | | Allows you to modify the join type (e.g., `Simple`, `Inner`, `Left`, `Right`, `Full`, `Cross`, `Natural`). **Alias** | | Lets you define a custom name for the join. **Add Column/Expression** | ![](../images/visual_query_builder/query_builder_add_icon.png) | Adds a new join condition. Select a row in **Table/Conditions** to enable this button in the right-side menu. Also available in the context menu. **Remove** | ![](../images/visual_query_builder/query_builder_remove_icon.png) | Removes the selected join condition. Select a row in **Table/Conditions** to enable this button in the right-side menu. Also available in the context menu. To change a join condition: * select the cell under **Table/Conditions** and edit the expression directly. * select the cell and click the three dots button to open the **Edit value** dialog. ![](../images/visual_query_builder/vqb-joins.png) ### Sorting¶ You can set the order of rows in the result table. Select the **Sorting** tab in the **Query settings**. In this tab, you can specify details related to the columns: Setting | Description ---|--- **Conditions or Expressions** | Click on the first cell in this column to display a drop-down list of all available columns. Select the column you want to sort by clicking on its name. **Order** | Defines whether the selected column should be sorted in ascending or descending order. ![](../images/visual_query_builder/vqb-sorting.png) #### Adding and removing sorting conditions¶ * **Adding a sorting condition** : Click the **Add** button ![](../images/visual_query_builder/query_builder_add_icon.png) on the right side of the tab. This action will create a new sorting row, and a default `ORDER BY` expression will be automatically added to the SQL script area. * **Removing a sorting condition** : To remove an existing sorting condition, select the row containing the condition you wish to delete and click the **Remove** button ![](../images/visual_query_builder/query_builder_remove_icon.png) on the right side of the tab. ### Miscellaneous¶ You can configure additional settings in the **Miscellaneous** tab. Setting | Description ---|--- **Add table aliases** | Enable or disable the automatic generation of aliases for tables by selecting this check-box. **Use fully qualified table names** | Use full table names (including schema) by selecting this check-box, which disables auto-completion for table names. **Auto-create joins according to foreign keys** | Enable or disable the automatic creation of joins based on foreign key relationships. **Autosave on SQL-editor switch** | Enable autosave when switching between SQL editors by selecting this check-box. ![](../images/visual_query_builder/vqb-miscellaneous.png) ### Disable Visual Query Builder¶ You can disable the **Visual Query Builder**. When disabled, the **Builder** tab in the SQL Editor is hidden. 1. Go to **Window - > Preferences -> SQL Editor** 2. In the **SQL Presentations** section, check the box **Disable Visual Query Builder** 3. Click **Apply and Close** Tip You can also disable the Visual Query Builder in [admin preferences](../Admin- Manage-Preferences/#sql-editor-settings). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Windows-Silent-Install/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * Windows silent install [ Windows silent install ](./) Table of contents * Parameters * For install * For uninstall * Installer return codes * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Parameters * For install * For uninstall * Installer return codes 1. [DBeaver](/docs/dbeaver) 2. Administration # Windows silent install It is possible to install/uninstall DBeaver in silent mode using the Windows Installer command line parameters. This might be beneficial for mass install automation (SSCM and other similar systems). ## Parameters¶ Command line parameters supported by DBeaver installer/uninstaller: Parameter | Description ---|--- `/S` | Enables silent mode. Requires either `/allusers` or `/currentuser`. Case-sensitive. `/D=path` | Sets the installation directory. This parameter must be the last one used and is case-sensitive. No quotes needed. `/allusers` | Installs or uninstalls the software for all users. Case-insensitive. `/currentuser` | Installs or uninstalls the software for the current user only. Case-insensitive. ### For install¶ To install DBeaver, navigate to the directory where the installer is located and append the desired parameters to the command: For instance: C:\Program Files\DBeaver> [parameters] Note To install with the `/allusers` parameter the current user must have the administrator's permission. ### For uninstall¶ To uninstall DBeaver, use the `Uninstaller.exe` from the DBeaver directory with the required parameters: For instance: C:\Program Files\DBeaver>Uninstaller.exe [parameters] ## Installer return codes¶ Code | Meaning ---|--- `0` | normal execution (no error) `1` | (un)installation aborted by user (Cancel button) `2` | (un)installation aborted by script `666660` | invalid command-line parameters `666661` | elevation is not allowed by defines `666662` | uninstaller detected there is no installed version `666663` | executing uninstaller from the installer failed `666666` | cannot start elevated instance other | Windows error code when trying to start elevated instance" Info Installer was improved in DBeaver 5.3.3, special thanks to the [NsisMultiUser](https://github.com/Drizin/NsisMultiUser) team. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Working-with-Dictionary-Data/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * Dictionary data [ Dictionary data ](./) Table of contents * Dictionary options * Dictionary preferences * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Dictionary options * Dictionary preferences 1. [DBeaver](/docs/dbeaver) 2. Data Editor # Dictionary data Relational databases often store related values in separate tables connected by foreign keys. In DBeaver, you can view and edit these values directly in the [Value viewer](../Value-Panel/). The panel shows a list of keys and their corresponding descriptions for quick lookup. ![](../images/ug/work-with-dictionaries.png) Tip If you want to see full details of the referenced record, open the same foreign key in the [References panel](../References-Panel/) — it displays all columns from the related table. ## Dictionary options¶ In the **Value viewer** , you can: * **Edit value** \- change the current cell value directly. * **Dictionary** \- view the referenced table for the foreign key. Click to open it in a new tab. * **Define description** \- open a window where you can: * Choose columns for the dictionary description or set custom criteria. * Define a custom expression for descriptions. * Set a column delimiter. * **Search** \- find dictionary entries by typing a value or part of a description string. ## Dictionary preferences¶ You can customize how dictionaries behave in **Value viewer** : 1. Go to **Window - > Preferences -> Editors -> Data Editor -> Dictionaries**. 2. Configure the following options: Setting | Description ---|--- **Keywords for dictionary description columns** | Define which keywords are used to identify description columns. **Maximum number of elements per page** | Set how many dictionary entries appear on one page. These settings give you more control over how dictionary data is displayed and managed. Info For an overview of Panels, see [Panels](../Panels/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Working-with-Shell-Commands-in-DBeaver/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * Shell commands [ Shell commands ](./) Table of contents * How to Work with Shell Commands * Events * Command Window * Settings * Examples * Example 1 - Backup PostgreSQL Database Before Disconnect * Example 2 - Run a Script After Connect * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * How to Work with Shell Commands * Events * Command Window * Settings * Examples * Example 1 - Backup PostgreSQL Database Before Disconnect * Example 2 - Run a Script After Connect 1. [DBeaver](/docs/dbeaver) 2. [Configure connection](/docs/dbeaver/Create-Connection) 3. Connection settings # Shell commands DBeaver offers the ability to execute shell commands. This feature allows you to automate various database tasks, such as running scripts or [backing up data](../Backup-Restore/), based on specific events. This article provides an insight into how to work with shell commands in DBeaver, including the events that can trigger these commands, the command window, settings, and examples. ## How to Work with Shell Commands¶ To configure and use shell commands in DBeaver, follow these steps: 1. Right-click on the database connection and select **Edit Connection**. 2. In the **Connection details** window, navigate to the **Shell commands** section. ![](../images/shell-scripts.png) From here, you can set up shell commands to be executed at different stages of the connection process, such as before connecting, after connecting, before disconnecting, and after disconnecting. You can also configure various settings to control the behavior of these commands. ### Events¶ Shell commands in DBeaver can be triggered by specific events. These events include: Event | Description ---|--- **Before Connect** | Executed before a connection is established. **After Connect** | Executed after a connection has been made. **Before Disconnect** | Executed before disconnecting from the database. **After Disconnect** | Executed after the disconnection. ### Command Window¶ The command window is where you can write the shell commands that you want to execute. It provides an interface to input the necessary commands, which will be executed upon the occurrence of one of the specified events. ### Settings¶ The settings for shell commands in DBeaver include several options that allow you to customize the behavior of the commands: Setting | Description ---|--- **Show Process Panel** | Enables a panel that displays the ongoing process. **Terminate Process at Disconnect** | Ends the process when the connection is terminated. **Wait for Process to Finish (ms)** | Specifies the time in milliseconds to wait for the process to complete. **Pause After Execute (ms)** | Defines a pause time in milliseconds after the execution of a command. **Working Directory** | Allows you to set the directory where the commands will be executed. For more information on the variables that can be used in commands, click on the informational tip within the settings. ## Examples¶ Here are some examples of how you can utilize **Shell commands** in DBeaver: ### Example 1 - Backup PostgreSQL Database Before Disconnect¶ 1. **Event** : Select **Before Disconnect**. 2. **Command Window** : Enter the following command: pg_dump -U username -h hostname -p port -F c -b -v -f /path/to/backup.sql database_name Replace `username`, `hostname`, `port`, `database_name`, and `/path/to/backup.sql` with your PostgreSQL credentials and the desired backup file path. 3. **Settings** : You may want to check **Show Process Panel** to see the progress of the backup. This command will create a custom-format dump of the specified PostgreSQL database. By setting this command to run before disconnecting, you can ensure that your database is backed up automatically each time you disconnect, providing an extra layer of security for your data. ### Example 2 - Run a Script After Connect¶ You can execute a specific script right after connecting to the database to automate routine tasks. Here's an example: 1. **Event** : Select "After Connect." 2. **Command Window** : Enter the following command: sh /path/to/your_script.sh Replace `/path/to/your_script.sh` with the actual path to the script you want to run. 3. **Settings** : You may want to set **Wait for Process to Finish (ms)** to ensure that the script completes before proceeding with other tasks. This command will execute the specified shell script immediately after connecting to the database. By setting this command to run after connecting, you can automate routine tasks, such as initializing specific settings or running maintenance scripts, each time you establish a connection. This automation enhances efficiency and ensures consistency in your database management process. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Working-with-Spatial-GIS-data/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * Spatial GIS data [ Spatial GIS data ](./) Table of contents * Spatial data viewer * Differentiating data on the map * Tile layer management * Defining custom tile layer * Viewing string or binary data from any Database on a map * Labels on a map * Copying the viewport area * Additional features * Copying coordinates * Miscellaneous buttons * Viewing Curve Geometries * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Spatial data viewer * Differentiating data on the map * Tile layer management * Defining custom tile layer * Viewing string or binary data from any Database on a map * Labels on a map * Copying the viewport area * Additional features * Copying coordinates * Miscellaneous buttons * Viewing Curve Geometries 1. [DBeaver](/docs/dbeaver) 2. Data Editor # Spatial GIS data Spatial data, often represented as either geometric or geographical values, can be visualized on a map or graph. A geometric object is typically composed of a sequence of points that define its shape. For a more comprehensive understanding of spatial data, you can refer to this [detailed explanation](https://en.wikipedia.org/wiki/Spatial_database). DBeaver's support of spatial data covers the following databases: * [PostgreSQL (PostGIS)](../Database-driver-PostgreSQL/) * [Greenplum](../Database-driver-Greenplum/) * [Redshift](../Database-driver-Amazon-Redshift/) * CockroachDB * [MySQL](../Database-driver-MySQL/) * [MariaDB](../Database-driver-MariaDB/) * [SQLite (GeoPackage)](../Database-driver-SQLite/) * H2GIS * SAP HANA * DuckDB * Exasol * Altibase * [Yellowbrick](../Database-driver-Yellowbrick/) * [Oracle](../Oracle/) ![](../images/commercial.png) * [SQL Server](../Database-driver-Microsoft-SQL-Server/) ![](../images/commercial.png) * [BigQuery](../Database-driver-BigQuery/) ![](../images/commercial.png) * [Snowflake](../Snowflake/) ![](../images/commercial.png) * [AlloyDB](../Database-driver-AlloyDB-for-PostgreSQL/) ![](../images/commercial.png) Each of these databases has its own set of features and capabilities for handling spatial data, and DBeaver is equipped to work effectively with each of them. ## Spatial data viewer¶ The Spatial data viewer in DBeaver is a tool designed to visualise and interact with spatial data. It provides a graphical representation of your spatial data, enhancing your ability to understand and analyze it. ![](../images/ug/Data-view-gis.png) ![](../images/ug/Data-view-gis-presentation.png) ### Differentiating data on the map¶ Every table column has its own color on the map. This helps you find the information you need on the map if you know which column it belongs to. If you click on an object on the map the following information will be displayed: 1. Name of the column in the header 2. Displayable data (strings, numbers, dates etc.) from every other column in the corresponding row ### Tile layer management¶ DBeaver has several predefined map tiles. The tiles can be chosen with the combo below the viewer: ![](../images/ug/gis-layer-management.png) You can select which tile layers you want to see using the layers button. This button includes a drop-down menu where you can either select a layer or click on the **Manage** option. The **Manage** option provides the ability to upload your own layers and hide pre-installed layers from the menu. ### Defining custom tile layer¶ At this point, you may be wondering what to put in the Layers definition box. Here is a brief explanation. DBeaver's spatial data viewer uses Leaflet under the hood. To define a custom tile layer, you wll need to provide arguments for the `L.tileLayer()` function in the Layers definition box. This function is responsible for loading and displaying the tile layers on the map. For more detailed information on how to use the `L.tileLayer()` function, refer to the [official Leaflet documentation](https://leafletjs.com/index.html#tilelayer). To get started, you can also look at the definition of predefined tiles in DBeaver. ## Viewing string or binary data from any Database on a map¶ In DBeaver, you can visualize your geodata on the map, regardless of whether it is stored as string or binary data. To do this, select the data cell and navigate to the **View/Format** setting. From there, choose the **Set columnName format** option and select **Geometry** from the available formats. This feature allows you to transform and visualize your data in a spatial context, enhancing your understanding of the data. Tip It is particularly useful when working with geospatial datasets, as it enables you to see the geographical distribution and relationships of your data. ![](../images/ug/Data-view-gis-string-to-spatial.png) ## Labels on a map¶ You can also enable labels on the map using the **Show labels** button. This feature allows you to visualize specific data on the map, providing a more detailed view of your spatial data. ![](../images/ug/gis-labels.png) The **Show labels** button includes a drop-down menu with an option to **Configure labels**. Selecting this option opens a window where you can customize what data will be visualized in the labels, the order of the data, and the delimiter between the data. Tip Once the labels are enabled, the button's name changes to **Hide labels** , allowing you to easily toggle the display of labels on the map. ## Copying the viewport area¶ DBeaver's spatial data viewer also includes a feature that allows you to copy the extent of the current viewport area. To use this feature, adjust the viewport to the area of interest using the zoom and drag functions. Then, select the **Copy viewport bounds** option. This action will copy the coordinates that represent the extent of the current view area. You can then paste these coordinates into your SQL query or any other place where you need to use them. Tip This feature can be useful when you need to examine all spatial data within a specific area or when you want to check their attributes in relation to a particular spatial object. Here's an example of how you can use these coordinates in an SQL query: SELECT geom FROM your_table WHERE ST_Intersects( ST_MakeEnvelope(, 4326), ST_Transform(geom, 4326) ); ![](../images/ug/gis-viewport-area.png) In this query, you replace `` with the coordinates you copied from the viewport. * The `ST_MakeEnvelope` function creates a rectangular polygon using these coordinates. * The `ST_Intersects` function then finds any spatial objects in the provinces table that intersect with this rectangle. * The `ST_Transform` function is used to ensure that the geometries are in the same coordinate system (in this case, `EPSG:4326`). Tip If you want to copy the extent of a specific selection, you can use the **Toggle lasso** tool to **Copy selection bounds** , and copy the coordinates. ## Additional features¶ ### Copying coordinates¶ You can copy coordinates to the clipboard from any point on the map: just right-click anywhere and select **Copy coordinates**. It copies the coordinates formatted as `latitude`, `longitude` to the clipboard.\ Note The coordinates are copied according to `EPSG:4326 CRS` and are just raw numbers. You may need to remove a comma and switch the `latitude` and `longitude` places to correctly insert it into a database. ### Miscellaneous buttons¶ You can use buttons at the bottom of the view for additional features: * Open the temporary generated `HTML` file in your default browser. * Copy the current map to the clipboard as a picture. * Save the current map as a picture into the selected folder. * Print the current map. * Flip the `latitude` and `longitude` coordinates in the source data. This can be useful if the data in your table is saved in (`latitude`/`longitude`) format while the Leaflet reads it as (`longitude`, `latitude`). This button does not change anything in the source data, it just changes how this data is read to show the accurate information on the map. ### Viewing Curve Geometries¶ You can now visualize the curve geometries in DBeaver's spatial data viewer. This enhancement allows you to work with complex spatial data types such as `CIRCULARSTRING`, `COMPOUNDCURVE`, `CURVEPOLYGON`, `MULTICURVE`, and `MULTISURFACE`. You can use SQL functions like `st_geomfromtext` and `st_curvetoline` to create and view curve geometries. Tip This feature can be specifically useful when dealing with complex spatial datasets in PostGIS that include curved geometries. It allows for more precise representation and analysis of geographical features that are not adequately represented by simple polygons or lines, such as circular areas of interest, roads that follow curved paths, or areas defined by a radius from a certain point. Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Working-with-XML-and-JSON/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * XML and JSON data [ XML and JSON data ](./) Table of contents * Editing XML and JSON data * Editing JSON data * Editing XML data * Working with XML and JSON data in the Value panel * Formatting options * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * [ Workspace location ](../Workspace-Location/) * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Editing XML and JSON data * Editing JSON data * Editing XML data * Working with XML and JSON data in the Value panel * Formatting options 1. [DBeaver](/docs/dbeaver) 2. Data Editor # XML and JSON data DBeaver supports XML and JSON column types (in relational databases) by using standard JDBC interfaces. This feature was added in JDBC4 so you will need JDBC4 compliant driver for your database. ## Editing XML and JSON data¶ You can interact with XML/JSON data directly in the **Data Editor**. ### Editing JSON data¶ You can edit JSON data directly in the cell. For more complex or large JSON datasets, use the full-size editor: 1. Click a cell containing JSON data. 2. Press `Shift+Enter` to open the full-size editor in a new tab. ![](../images/ug/JSON_editor.png) Tip Use **Auto Format** to adjust spacing and indentation for better readability. Shortcut: ` Ctrl+Shift+F`. ### Editing XML data¶ To work with XML data, switch to the **XML** tab available on the left side of the **Data Editor**. You can edit XML content directly within this tab. ![](../images/ug/XML-tab-in-Data-Editor.png) ## Working with XML and JSON data in the Value panel¶ You can also interact with XML/JSON data using the **Value panel** , which provides tools for formatting, uploading, saving, and switching formats. ![](../images/ug/XML-in-Value-panel.png) Note The Value panel isn't available when working in the **XML** tab. For more details, see [Value Viewer](../Value-Panel/). ### Formatting options¶ Through the context menu (right-click within the Value panel), you can access the following features to improve readability and manage text display: Action | Description | Shortcut ---|---|--- **Auto Format** | Adjust spacing and indentation for better readability. | `Ctrl+Shift+F` (`⌃⇧F` for macOS) **Toggle Word Wrap** | Enable or disable word wrapping within the editor. | Back to top --- # Source: https://dbeaver.com/docs/dbeaver/Workspace-Location/ Expand all * [ Getting started ](..) Getting started * [ First steps ](../Getting-started/) * [ Installation ](../Installation/) * [ Application window overview ](../Application-Window-Overview/) * [ Basic operations ](../Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](../User-Interface-Themes/) * [ Interface language ](../UI-Language/) * [ Accessibility ](../Accessibility-Guide/) * [ Toolbar customization ](../Toolbar-Customization/) * [ Database object editor ](../Database-Object-Editor/) * [ Reset UI settings ](../Reset-UI-settings/) * [ Shortcuts ](../Shortcuts/) * Security Security * [ Security in DBeaver PRO ](../Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](../Security/) * [ Master password ](../Managing-Master-Password/) * [ Automation (console) security ](../Automation-Security/) * [ Integrated security ](../Integrated-Security/) * [ Secret Management ](../Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](../Create-Connection/) * [ Edit connection ](../Edit-Connection/) * [ Invalidate and reconnect ](../Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](../Disconnect-from-Database/) * [ Change current user password ](../Change-current-user-password/) * [ Shell commands ](../Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](../Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](../Managing-security-restrictions-for-database-connection/) * [ Connection types ](../Connection-Types/) * [ Local client configuration ](../Local-Client-Configuration/) * [ Multiple datasource connections ](../Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](../Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](../SSH-Configuration/) * SSL SSL * [ SSL configuration ](../SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](../Managing-Truststore-Settings/) * [ Import custom certificates ](../Import-SSL-Certificates/) * [ Oracle SSL configuration ](../SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](../Proxy-configuration/) * [ Proxy configuration with system files ](../Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](../Kubernetes-configuration/) * [ AWS SSM configuration ](../AWS-SSM-Configuration/) * [ Network profiles ](../Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](../Transaction-Log/) * [ Pending transactions ](../Pending-Transactions/) * [ Auto and manual commit modes ](../Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](../Authentication-Database-Native/) * [ DBeaver profile ](../Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](../Authentication-Microsoft-Entra-ID/) * [ Kerberos ](../Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](../Driver-Manager/) * [ ODBC & JDBC driver ](../ODBC-JDBC-Driver/) * [ File-based driver properties ](../File-based-driver-properties/) * [ How to add additional artifacts to the driver ](../How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](../JDBC-Time-Zones/) * [ JDBC tracing ](../JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](../Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](../Database-drivers/) * Classic Classic * [ Apache Hive ](../Apache-Hive/) * [ Cassandra ](../Cassandra/) * [ ClickHouse ](../Clickhouse/) * [ Couchbase ](../Couchbase/) * [ IBM Db2 ](../Database-driver-IBM-Db2/) * [ Greenplum ](../Database-driver-Greenplum/) * [ InfluxDB ](../InfluxDB/) * [ Microsoft SQL Server ](../Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](../Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](../MongoDB/) * [ MongoDB authentication ](../Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](../Database-driver-MySQL/) * [ Two-factor authentication ](../Authentication-MySQL-Two-factor/) * [ Netezza ](../Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](../Oracle/) * [ Oracle authentication ](../Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](../Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](../Database-driver-PostgreSQL/) * [ PgPass authentication ](../Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](../Authentication-PostgreSQL-SSPI/) * [ Redis ](../Redis/) * Salesforce Salesforce * [ Salesforce ](../Database-driver-Salesforce/) * [ Salesforce authentication ](../Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](../Database-driver-Teradata/) * [ LDAP authentication in Teradata ](../Authentication-LDAP-Mechanism/) * [ Trino ](../Database-driver-Trino/) * [ Yellowbrick ](../Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](../Database-driver-Amazon-Athena/) * [ Aurora DSQL ](../Database-driver-Aurora-DSQL/) * [ DocumentDB ](../AWS-DocumentDB/) * [ DynamoDB ](../AWS-DynamoDB/) * [ Keyspaces ](../AWS-Keyspaces/) * [ Neptune ](../Database-driver-Neptune/) * [ Redshift ](../Database-driver-Amazon-Redshift/) * [ Timestream ](../Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](../Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](../Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](../Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](../Database-driver-BigQuery/) * [ Bigtable ](../Google-Bigtable/) * [ Cloud SQL for MySQL ](../Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](../Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](../Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](../Database-driver-Firestore/) * [ Spanner ](../Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](../Database-driver-Databricks/) * [ Databricks authentication ](../Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](../Snowflake/) * [ Snowflake authentication ](../Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](../Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](../Database-driver-Files-MultiSource/) * [ CSV ](../Database-driver-CSV/) * [ JSON ](../Database-driver-JSON/) * [ Parquet ](../Database-driver-Parquet/) * [ XLSX ](../Database-driver-XLSX/) * [ XML ](../Database-driver-XML/) * Graph Graph * [ Neo4j ](../Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](../Database-Navigator/) * [ Simple and advanced view ](../Simple-and-Advanced-View/) * [ Configuring filters ](../Configure-Filters/) * [ Filter database objects ](../Filter-Database-Objects/) * [ Bookmarks ](../Bookmarks/) * Projects Projects * [ Projects ](../Projects/) * [ Projects view ](../Projects-View/) * [ Project security ](../Project-security/) * [ Project explorer ](../Project-Explorer/) * Search Search * [ Search ](../Search-Tool/) * [ Data search ](../Data-Search/) * [ Full-text search database ](../DB-Full-Text-Search/) * [ Metadata search ](../DB-Metadata-Search/) * [ File search ](../File-Search/) * [ Properties Editor ](../Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](../Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](../Data-View-and-Format/) * [ Data filters ](../Data-Filters/) * [ Data viewing and editing ](../Data-Viewing-and-Editing/) * [ Data refresh ](../Data-Refresh/) * [ Result set navigation ](../Navigation/) * Panels Panels * [ Panels ](../Panels/) * [ Value Panel ](../Value-Panel/) * [ References Panel ](../References-Panel/) * [ Metadata Panel ](../Metadata-Panel/) * [ Grouping Panel ](../Grouping-Panel/) * [ Calc Panel ](../Calc-Panel/) * [ Result details Panel ](../Result-Details-Panel/) * [ Query trace Panel ](../Query-Trace-Panel/) * [ Managing charts ](../Managing-Charts/) * [ Mock data generation ](../Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](../Dashboards/) * [ XML and JSON data ](../Working-with-XML-and-JSON/) * [ Dictionary data ](../Working-with-Dictionary-Data/) * [ Spatial GIS data ](../Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](../Virtual-column-expressions/) * [ Virtual keys ](../Virtual-Keys/) * [ Data Editor preferences ](../Data-Editor-preferences/) * [ Data format preferences ](../Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](../SQL-Editor/) * [ Visual query builder ](../Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](../SQL-Execution/) * [ Query execution plan ](../Query-Execution-Plan/) * [ Script management ](../Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](../SQL-Assist-and-Auto-Complete/) * [ SQL templates ](../SQL-Templates/) * [ SQL query formatter ](../SQL-Formatting/) * [ Variables panel ](../Variables-panel/) * [ Spelling ](../Spelling/) * [ SQL generation ](../SQL-Generation/) * [ SQL terminal ](../SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](../Client-Side-Scripting/) * [ Export command ](../Export-Command/) * [ Query manager ](../Query-Manager/) * [ SQL code Editor ](../SQL-Code-Editor/) * [ SQL Plus script execution ](../SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](../PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](../PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](../ER-Diagrams/) * [ Database structure diagrams ](../Database-Structure-Diagrams/) * [ Custom diagrams ](../Custom-Diagrams/) * [ Edit mode for diagrams ](../Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](../Cloud-Explorer/) * [ AWS cloud explorer ](../AWS-Cloud-Explorer/) * [ Azure cloud explorer ](../Azure-Cloud-Explorer/) * [ Google cloud explorer ](../Google-Cloud-Explorer/) * [ Cloud storage ](../Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](../AWS-Permissions/) * [ AWS SSO ](../AWS-SSO/) * [ AWS credentials ](../AWS-Credentials/) * Azure Azure * [ Azure permissions ](../Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](../GCP-SSO/) * [ Google Cloud credentials ](../GCP-Credentials/) * AI AI * [ AI Assistant ](../AI-Smart-Assistance/) * [ Data privacy ](../AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](../AI-chat/) * [ Speech recognition ](../AI-speech-recognition/) * AI functions AI functions * [ AI functions ](../AI-Functions/) * [ Data transfer actions ](../Data-Transfer-Actions/) * [ Advanced metadata actions ](../Advanced-Metadata-Read-Actions/) * [ View and editor actions ](../View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](../AI-query-suggestion/) * [ Explain query ](../AI-query-explanation/) * [ Fix SQL errors ](../AI-error-explanation/) * [ AI command ](../AI-command/) * Work with objects Work with objects * [ Describe object with AI ](../AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](../Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](../AI-Assistance-settings/) * Providers Providers * [ OpenAI ](../AI-integration-with-OpenAI/) * [ GitHub Copilot ](../AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](../AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](../AI-integration-with-Google-Gemini/) * [ Ollama ](../AI-integration-with-Ollama/) * [ Anthropic Claude ](../AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](../AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](../Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](../Data-transfer/) * [ Data import ](../Data-import/) * [ Data import and replace ](../Data-Import-and-Replace/) * [ Data export ](../Data-export/) * [ Data transfer external storage ](../Data-transfer-external-storage/) * [ Data migration ](../Data-migration/) * [ Data transfer via email ](../Data-transfer-email/) * [ Data compare ](../Data-compare/) * [ Backup and restore ](../Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](../Schema-compare/) * [ Liquibase support ](../Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](../Task-Management/) * [ Task scheduler ](../Task-Scheduler/) * [ Composite tasks ](../Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](../Project-team-work/) * [ Tableau integration ](../Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](../PGDebugger/) * [ Session Manager ](../Session-Manager-Guide/) * [ Lock Manager ](../Lock-Manager/) * [ Eclipse extensions ](../Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](../New-Table-Creation/) * [ Incorporating triggers ](../Incorporating-Triggers/) * [ Creating columns ](../Creating-columns/) * [ Creating indexes ](../Creating-Indexes/) * [ Implementing constraints ](../Implementing-Constraints/) * [ Utilizing foreign keys ](../Utilizing-Foreign-Keys/) * [ Sample database ](../Sample-Database/) * [ Database partitions ](../How-to-work-with-database-Partitions/) * [ Import connections from external tools ](../How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](../Admin-Manage-Preferences/) * [ Admin manage drivers ](../Admin-Manage-Drivers/) * [ Admin preference restrictions ](../Admin-Preference-Restrictions/) * [ Admin variables ](../Admin-Variables/) * General configuration General configuration * [ Configuration files ](../Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](../Admin-Manage-Connections/) * [ Pre-configured variables ](../Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](../How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](../Command-Line/) * [ Error log ](../Log-files/) * [ Background tasks ](../Background-Tasks/) * Workspace location [ Workspace location ](./) Table of contents * Default location of the workspace * Folders inside DBeaverData * Custom location * Old default workspace location * Ancient default workspace location * Migrating workspace * Export and import * Git integration * [ Resetting your workspace ](../Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](../Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](../Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](../Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](../Making-a-thread-dump/) * [ Posting issues ](../Posting-issues/) * [ Windows silent install ](../Windows-Silent-Install/) * [ Snap installation ](../Snap-installation/) * Licenses Licenses * [ Import license ](../How-to-Import-License/) * [ Update license ](../How-to-Update-License/) * [ Reassign license ](../How-to-Reassign-License/) * [ License administration ](../License-Administration/) * License types License types * [ License types ](../Differences-between-license-types/) * [ Early Access Program (EAP) license ](../Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](../Enterprise-Edition/) * [ Lite edition ](../Lite-Edition/) * [ Ultimate edition ](../Ultimate-Edition/) * [ Release cycles ](../DBeaver-release-cycles/) * [ Statistics collection ](../Statistics-Collection/) * [ Customer technical support ](../Customer-technical-support-information/) * [ FAQ ](../FAQ/) Table of contents * Default location of the workspace * Folders inside DBeaverData * Custom location * Old default workspace location * Ancient default workspace location * Migrating workspace * Export and import * Git integration 1. [DBeaver](/docs/dbeaver) 2. [Administration](/docs/dbeaver/Admin-Manage-Preferences) 3. General configuration # Workspace location ## Default location of the workspace¶ By default, DBeaver stores all its files (configurations, scripts, diagrams, etc.) in the following folder: OS | Location ---|--- Windows | `%APPDATA%\DBeaverData\` MacOS | `~/Library/DBeaverData/` Linux | `$XDG_DATA_HOME/DBeaverData/` ($XDG_DATA_HOME=`~/.local/share` if not set) ### Folders inside DBeaverData¶ Folder | Location ---|--- `workspace6` | Workspace files for DBeaver (Community, Lite, Enterprise and Ultimate). `drivers` | Auto downloaded database drivers. `install-data` | Runtime files used by different versions ofr product. `secure` | Global credentials (encrypted with master password). `settings` | Global settings (e.g. user interface language). ## Custom location¶ You can specify a custom workspace location by passing parameter `-data ` in the command line. `` can be an absolute or relative directory path. ## Old default workspace location¶ Old - means before DBeaver 6.1.3 OS | Location ---|--- Windows | `C:\Users\YourName\.dbeaver4`. Linux | `~/.dbeaver4/` MacOS | `~/.dbeaver4/` ## Ancient default workspace location¶ Ancient - means before DBeaver 4. OS | Location ---|--- Windows | `C:\Users\YourName\.dbeaver`. Linux | `~/.dbeaver/` MacOS | `~/.dbeaver/` ## Migrating workspace¶ To transfer everything, including configurations, projects, scripts, diagrams, and other workspace data, copy the entire workspace folder and place it in the corresponding location on the new machine. Alternatively, you can export and import specific items like **Projects** , **Scripts** , or **Preferences** separately, or use **Git integration** to manage and sync your work: ### Export and import¶ To transfer specific items like **Projects** , **Scripts** , or **Preferences** , use DBeaver's export and import functionality. For detailed steps, see: * Exporting and importing [projects](../Projects/#exporting-and-importing-projects) and [scripts](../Script-Management/#exporting-and-importing-scripts). * [Importing and Exporting workspace configuration](../Admin-Manage-Preferences/#importing-and-exporting-workspace-configuration). ### Git integration¶ Use DBeaver's Git integration to save and sync your projects, scripts, and settings. For more details, see [Project team work](../Project-team-work/). Back to top --- # Source: https://dbeaver.com/docs/dbeaver/ Expand all * [ Getting started ](.) Getting started * [ First steps ](Getting-started/) * [ Installation ](Installation/) * [ Application window overview ](Application-Window-Overview/) * [ Basic operations ](Basic-operations/) * DBeaver configuration DBeaver configuration * [ User interface ](User-Interface-Themes/) * [ Interface language ](UI-Language/) * [ Accessibility ](Accessibility-Guide/) * [ Toolbar customization ](Toolbar-Customization/) * [ Database object editor ](Database-Object-Editor/) * [ Reset UI settings ](Reset-UI-settings/) * [ Shortcuts ](Shortcuts/) * Security Security * [ Security in DBeaver PRO ](Security-in-DBeaver-PRO/) * Password secure storage Password secure storage * [ Secure storage ](Security/) * [ Master password ](Managing-Master-Password/) * [ Automation (console) security ](Automation-Security/) * [ Integrated security ](Integrated-Security/) * [ Secret Management ](Secret-Providers/) * Configure connection Configure connection * Connection settings Connection settings * [ Create connection ](Create-Connection/) * [ Edit connection ](Edit-Connection/) * [ Invalidate and reconnect ](Invalidate-and-Reconnect-to-Database/) * [ Disconnect from database ](Disconnect-from-Database/) * [ Change current user password ](Change-current-user-password/) * [ Shell commands ](Working-with-Shell-Commands-in-DBeaver/) * [ Initialization settings ](Configure-Connection-Initialization-Settings/) * [ Security restrictions for database connection ](Managing-security-restrictions-for-database-connection/) * [ Connection types ](Connection-Types/) * [ Local client configuration ](Local-Client-Configuration/) * [ Multiple datasource connections ](Separate-Connections/) * Network configuration Network configuration * [ Network configuration ](Network-configuration/) * Connection network options Connection network options * [ SSH configuration ](SSH-Configuration/) * SSL SSL * [ SSL configuration ](SSL-Configuration/) * Truststore management Truststore management * [ Manage certificates ](Managing-Truststore-Settings/) * [ Import custom certificates ](Import-SSL-Certificates/) * [ Oracle SSL configuration ](SSL-Configuration-Oracle/) * Proxy Proxy * [ Proxy configuration ](Proxy-configuration/) * [ Proxy configuration with system files ](Proxy-configuration-with-system-files/) * [ Kubernetes configuration ](Kubernetes-configuration/) * [ AWS SSM configuration ](AWS-SSM-Configuration/) * [ Network profiles ](Network-profiles/) * Transaction mode Transaction mode * [ Transaction log ](Transaction-Log/) * [ Pending transactions ](Pending-Transactions/) * [ Auto and manual commit modes ](Auto-and-Manual-Commit-Modes/) * Database authentication models Database authentication models * [ Database native ](Authentication-Database-Native/) * [ DBeaver profile ](Authentication-DBeaver-profile/) * [ Microsoft Entra ID ](Authentication-Microsoft-Entra-ID/) * [ Kerberos ](Kerberos-Authentication/) * Driver settings Driver settings * [ Driver manager ](Driver-Manager/) * [ ODBC & JDBC driver ](ODBC-JDBC-Driver/) * [ File-based driver properties ](File-based-driver-properties/) * [ How to add additional artifacts to the driver ](How-to-add-additional-artifacts-to-the-driver/) * [ JDBC time zones ](JDBC-Time-Zones/) * [ JDBC tracing ](JDBC-Tracing/) * [ Deprecated legacy ODBC driver ](Deprecated-legacy-ODBC-driver/) * Databases support Databases support * [ Database drivers ](Database-drivers/) * Classic Classic * [ Apache Hive ](Apache-Hive/) * [ Cassandra ](Cassandra/) * [ ClickHouse ](Clickhouse/) * [ Couchbase ](Couchbase/) * [ IBM Db2 ](Database-driver-IBM-Db2/) * [ Greenplum ](Database-driver-Greenplum/) * [ InfluxDB ](InfluxDB/) * [ Microsoft SQL Server ](Database-driver-Microsoft-SQL-Server/) * [ MariaDB ](Database-driver-MariaDB/) * MongoDB MongoDB * [ MongoDB ](MongoDB/) * [ MongoDB authentication ](Authentication-MongoDB/) * MySQL MySQL * [ MySQL ](Database-driver-MySQL/) * [ Two-factor authentication ](Authentication-MySQL-Two-factor/) * [ Netezza ](Database-driver-Netezza/) * Oracle Oracle * [ Oracle ](Oracle/) * [ Oracle authentication ](Connecting-to-Oracle-databases/) * [ JDBC OCI driver ](Connecting-to-Oracle-Database-using-JDBC-OCI-driver/) * PostgreSQL PostgreSQL * [ PostgreSQL ](Database-driver-PostgreSQL/) * [ PgPass authentication ](Authentication-PostgreSQL-Pgpass/) * [ SSPI (Windows SSO) ](Authentication-PostgreSQL-SSPI/) * [ Redis ](Redis/) * Salesforce Salesforce * [ Salesforce ](Database-driver-Salesforce/) * [ Salesforce authentication ](Authentication-Salesforce/) * Teradata Teradata * [ Teradata ](Database-driver-Teradata/) * [ LDAP authentication in Teradata ](Authentication-LDAP-Mechanism/) * [ Trino ](Database-driver-Trino/) * [ Yellowbrick ](Database-driver-Yellowbrick/) * Cloud Cloud * AWS AWS * [ Athena ](Database-driver-Amazon-Athena/) * [ Aurora DSQL ](Database-driver-Aurora-DSQL/) * [ DocumentDB ](AWS-DocumentDB/) * [ DynamoDB ](AWS-DynamoDB/) * [ Keyspaces ](AWS-Keyspaces/) * [ Neptune ](Database-driver-Neptune/) * [ Redshift ](Database-driver-Amazon-Redshift/) * [ Timestream ](Database-driver-Amazon-Timestream/) * Azure Azure * [ Cosmos DB ](Database-driver-CosmosDB/) * [ Cosmos DB for NoSQL ](Database-driver-Azure-CosmosDB-for-NoSQL/) * Google Google * [ AlloyDB for PostgreSQL ](Database-driver-AlloyDB-for-PostgreSQL/) * [ BigQuery ](Database-driver-BigQuery/) * [ Bigtable ](Google-Bigtable/) * [ Cloud SQL for MySQL ](Database-driver-MySQL-on-Google-Cloud/) * [ Cloud SQL for PostgreSQL ](Database-driver-PostgreSQL-on-Google-Cloud/) * [ Cloud SQL for SQL Server ](Database-driver-Microsoft-SQL-Server-on-Google-Cloud/) * [ Firestore ](Database-driver-Firestore/) * [ Spanner ](Database-driver-Google-Cloud-Spanner/) * Databricks Databricks * [ Databricks ](Database-driver-Databricks/) * [ Databricks authentication ](Authentication-Databricks/) * Snowflake Snowflake * [ Snowflake ](Snowflake/) * [ Snowflake authentication ](Authentication-Snowflake/) * Embedded Embedded * [ SQLite ](Database-driver-SQLite/) * File drivers File drivers * [ Multi source ](Database-driver-Files-MultiSource/) * [ CSV ](Database-driver-CSV/) * [ JSON ](Database-driver-JSON/) * [ Parquet ](Database-driver-Parquet/) * [ XLSX ](Database-driver-XLSX/) * [ XML ](Database-driver-XML/) * Graph Graph * [ Neo4j ](Database-driver-Neo4j/) * Navigation Navigation * Database Navigator Database Navigator * [ Database Navigator ](Database-Navigator/) * [ Simple and advanced view ](Simple-and-Advanced-View/) * [ Configuring filters ](Configure-Filters/) * [ Filter database objects ](Filter-Database-Objects/) * [ Bookmarks ](Bookmarks/) * Projects Projects * [ Projects ](Projects/) * [ Projects view ](Projects-View/) * [ Project security ](Project-security/) * [ Project explorer ](Project-Explorer/) * Search Search * [ Search ](Search-Tool/) * [ Data search ](Data-Search/) * [ Full-text search database ](DB-Full-Text-Search/) * [ Metadata search ](DB-Metadata-Search/) * [ File search ](File-Search/) * [ Properties Editor ](Properties-Editor/) * Data Editor Data Editor * [ Data Editor ](Data-Editor/) * Viewing and editing data Viewing and editing data * [ Data view and format ](Data-View-and-Format/) * [ Data filters ](Data-Filters/) * [ Data viewing and editing ](Data-Viewing-and-Editing/) * [ Data refresh ](Data-Refresh/) * [ Result set navigation ](Navigation/) * Panels Panels * [ Panels ](Panels/) * [ Value Panel ](Value-Panel/) * [ References Panel ](References-Panel/) * [ Metadata Panel ](Metadata-Panel/) * [ Grouping Panel ](Grouping-Panel/) * [ Calc Panel ](Calc-Panel/) * [ Result details Panel ](Result-Details-Panel/) * [ Query trace Panel ](Query-Trace-Panel/) * [ Managing charts ](Managing-Charts/) * [ Mock data generation ](Mock-Data-Generation-in-DBeaver/) * [ Dashboards ](Dashboards/) * [ XML and JSON data ](Working-with-XML-and-JSON/) * [ Dictionary data ](Working-with-Dictionary-Data/) * [ Spatial GIS data ](Working-with-Spatial-GIS-data/) * Virtual entities Virtual entities * [ Virtual columns ](Virtual-column-expressions/) * [ Virtual keys ](Virtual-Keys/) * [ Data Editor preferences ](Data-Editor-preferences/) * [ Data format preferences ](Managing-Data-Formats/) * SQL Editor SQL Editor * [ SQL Editor ](SQL-Editor/) * [ Visual query builder ](Visual-Query-Builder/) * Query execution Query execution * [ SQL execution ](SQL-Execution/) * [ Query execution plan ](Query-Execution-Plan/) * [ Script management ](Script-Management/) * Query development and assistance Query development and assistance * [ SQL Assist and Auto Complete ](SQL-Assist-and-Auto-Complete/) * [ SQL templates ](SQL-Templates/) * [ SQL query formatter ](SQL-Formatting/) * [ Variables panel ](Variables-panel/) * [ Spelling ](Spelling/) * [ SQL generation ](SQL-Generation/) * [ SQL terminal ](SQL-Terminal/) * Client side commands Client side commands * [ Client side scripting ](Client-Side-Scripting/) * [ Export command ](Export-Command/) * [ Query manager ](Query-Manager/) * [ SQL code Editor ](SQL-Code-Editor/) * [ SQL Plus script execution ](SQL-Plus-Script-Execution/) * [ PostgreSQL Arrays ](PostgreSQL-Arrays/) * [ PostgreSQL Extensions ](PostgreSQL-Extensions/) * Entity relation diagrams Entity relation diagrams * [ ER Diagrams ](ER-Diagrams/) * [ Database structure diagrams ](Database-Structure-Diagrams/) * [ Custom diagrams ](Custom-Diagrams/) * [ Edit mode for diagrams ](Edit-mode/) * Cloud services Cloud services * Cloud explorer Cloud explorer * [ Cloud explorer ](Cloud-Explorer/) * [ AWS cloud explorer ](AWS-Cloud-Explorer/) * [ Azure cloud explorer ](Azure-Cloud-Explorer/) * [ Google cloud explorer ](Google-Cloud-Explorer/) * [ Cloud storage ](Cloud-Storage/) * Cloud connection settings Cloud connection settings * AWS AWS * [ AWS permissions ](AWS-Permissions/) * [ AWS SSO ](AWS-SSO/) * [ AWS credentials ](AWS-Credentials/) * Azure Azure * [ Azure permissions ](Azure-Permissions/) * Google Cloud Google Cloud * [ Google Cloud SSO ](GCP-SSO/) * [ Google Cloud credentials ](GCP-Credentials/) * AI AI * [ AI Assistant ](AI-Smart-Assistance/) * [ Data privacy ](AI-Assistance-and-Data-Privacy/) * Features Features * AI chat AI chat * [ AI chat ](AI-chat/) * [ Speech recognition ](AI-speech-recognition/) * AI functions AI functions * [ AI functions ](AI-Functions/) * [ Data transfer actions ](Data-Transfer-Actions/) * [ Advanced metadata actions ](Advanced-Metadata-Read-Actions/) * [ View and editor actions ](View-and-Editor-Actions/) * Work with SQL Work with SQL * [ Query suggestion ](AI-query-suggestion/) * [ Explain query ](AI-query-explanation/) * [ Fix SQL errors ](AI-error-explanation/) * [ AI command ](AI-command/) * Work with objects Work with objects * [ Describe object with AI ](AI-smart-metadata-description/) * Tutorials Tutorials * [ Quick start with AI ](Quick-start-with-AI-Assistance/) * Settings Settings * [ AI Assistant settings ](AI-Assistance-settings/) * Providers Providers * [ OpenAI ](AI-integration-with-OpenAI/) * [ GitHub Copilot ](AI-integration-with-GitHub-Copilot/) * [ Azure OpenAI ](AI-integration-with-Azure-OpenAI/) * [ Google Gemini ](AI-integration-with-Google-Gemini/) * [ Ollama ](AI-integration-with-Ollama/) * [ Anthropic Claude ](AI-integration-with-Anthropic-Claude/) * [ Amazon Bedrock ](AI-integration-with-Amazon-Bedrock/) * [ Disable AI Assistant ](Disable-AI-assistance/) * Data transfer and schema compare Data transfer and schema compare * Data transfer Data transfer * [ Data transfer ](Data-transfer/) * [ Data import ](Data-import/) * [ Data import and replace ](Data-Import-and-Replace/) * [ Data export ](Data-export/) * [ Data transfer external storage ](Data-transfer-external-storage/) * [ Data migration ](Data-migration/) * [ Data transfer via email ](Data-transfer-email/) * [ Data compare ](Data-compare/) * [ Backup and restore ](Backup-Restore/) * Schema compare Schema compare * [ Schema compare ](Schema-compare/) * [ Liquibase support ](Using-Liquibase-in-DBeaver/) * Tasks Tasks * [ Task management ](Task-Management/) * [ Task scheduler ](Task-Scheduler/) * [ Composite tasks ](Composite-Tasks/) * Integrated tools Integrated tools * [ GIT integration ](Project-team-work/) * [ Tableau integration ](Tableau-integration-in-DBeaver/) * [ Database debugger (PostgreSQL) ](PGDebugger/) * [ Session Manager ](Session-Manager-Guide/) * [ Lock Manager ](Lock-Manager/) * [ Eclipse extensions ](Eclipse-extensions/) * Tutorials Tutorials * Table Creation Table Creation * [ New table creation ](New-Table-Creation/) * [ Incorporating triggers ](Incorporating-Triggers/) * [ Creating columns ](Creating-columns/) * [ Creating indexes ](Creating-Indexes/) * [ Implementing constraints ](Implementing-Constraints/) * [ Utilizing foreign keys ](Utilizing-Foreign-Keys/) * [ Sample database ](Sample-Database/) * [ Database partitions ](How-to-work-with-database-Partitions/) * [ Import connections from external tools ](How-to-import-Connections-from-External-Tools/) * Administration Administration * Admin preferences Admin preferences * [ Admin manage preferences ](Admin-Manage-Preferences/) * [ Admin manage drivers ](Admin-Manage-Drivers/) * [ Admin preference restrictions ](Admin-Preference-Restrictions/) * [ Admin variables ](Admin-Variables/) * General configuration General configuration * [ Configuration files ](Configuration-files-in-DBeaver/) * [ Pre-configured database connections ](Admin-Manage-Connections/) * [ Pre-configured variables ](Pre-configured-Variables/) * [ How to set a variable if dbeaver.ini is read only ](How-to-set-a-variable-if-dbeaver-ini-is-read-only/) * [ Command line ](Command-Line/) * [ Error log ](Log-files/) * [ Background tasks ](Background-Tasks/) * [ Workspace location ](Workspace-Location/) * [ Resetting your workspace ](Reset-workspace/) * [ Importing CA certificates from your local Java into DBeaver ](Importing-CA-certificates-from-your-local-Java-into-DBeaver/) * Troubleshooting Troubleshooting * [ Troubleshooting system issues ](Troubleshooting-system-issues/) * [ Troubleshooting task scheduler issues ](Troubleshooting-task-scheduler-issues/) * [ Making a thread dump ](Making-a-thread-dump/) * [ Posting issues ](Posting-issues/) * [ Windows silent install ](Windows-Silent-Install/) * [ Snap installation ](Snap-installation/) * Licenses Licenses * [ Import license ](How-to-Import-License/) * [ Update license ](How-to-Update-License/) * [ Reassign license ](How-to-Reassign-License/) * [ License administration ](License-Administration/) * License types License types * [ License types ](Differences-between-license-types/) * [ Early Access Program (EAP) license ](Early-Access-Program-license/) * About DBeaver About DBeaver * Editions Editions * [ Enterprise edition ](Enterprise-Edition/) * [ Lite edition ](Lite-Edition/) * [ Ultimate edition ](Ultimate-Edition/) * [ Release cycles ](DBeaver-release-cycles/) * [ Statistics collection ](Statistics-Collection/) * [ Customer technical support ](Customer-technical-support-information/) * [ FAQ ](FAQ/) Table of contents * Where to start # Welcome to DBeaver Documentation¶ ![](images/dbeaver-head.png) This is the documentation for [DBeaver](https://dbeaver.com/), a universal database management tool for anyone who needs to work with data professionally. With DBeaver, you can manipulate your data as if working in a regular spreadsheet, create analytical reports from records across various data storages, and export information in the desired format. For advanced database users, DBeaver offers a powerful SQL editor, extensive administration features, tools for data and schema migration, database connection session monitoring, and much more. DBeaver comes in different editions, each tailored to different users and workflows. Find the one that best fits your workflow. DBeaver LiteDBeaver EnterpriseDBeaver Ultimate DBeaver Lite is designed for users who need essential database tools. It offers a simplified interface for data viewing and query execution, making it perfect for business users seeking an easy-to-use solution. [Learn more](Lite-Edition/) DBeaver Enterprise is tailored for professionals handling complex data environments. It includes advanced data visualization, SQL development tools, enhanced security, and administrative capabilities. [Learn more](Enterprise-Edition/) DBeaver Ultimate offers comprehensive database management with additional cloud integration. It includes all Enterprise features plus tools for managing cloud databases and services like AWS, Google Cloud, and Azure. [Learn more](Ultimate-Edition/) ## Where to start¶ * **Install DBeaver** Learn how to install DBeaver on your system. [Installation guide](Installation/) * **Import your license** Steps to activate your DBeaver license. [Activate license](How-to-Import-License/) * **Getting started** Learn the basics to get started with CloudBeaver, including setup steps and key features. [Quick start](Getting-started/) * **Application overview** Navigate the DBeaver interface with ease. [Interface basics](Application-Window-Overview/) * **First steps** Start exploring databases and performing basic operations. [First steps](Basic-operations/) * **Use AI** Use the built-in AI Assistant to simplify everyday tasks. [How to use AI](AI-Smart-Assistance/) * **Transfer data** Export, import, or copy data between databases and files. [Data transfer](Data-transfer/) * **Compare schemas** Compare database structures and generate DDL scripts, diagrams, or Liquibase reports. [Schema compare guide](Schema-compare/) Back to top