Database driver Azure CosmosDB for NoSQL

Note

This driver is available in Lite, Enterprise, Ultimate and Team 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 article for guidance.

Tip

DBeaver can connect to the Azure Cosmos DB for NoSQL databases using the 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.

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.

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 - Account key (article coming soon) - Microsoft Entra ID for Cosmos DB for NoSQL
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
• Database Navigator
• Security Settings Guide
• Filters Settings Guide
• Connection Initialization Settings Guide
• Shell Commands Guide

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

• Proxy Configuration

• Kubernetes Configuration

• AWS SSM

Secure Storage with Secret Providers

DBeaver supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see 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 Export
Dashboards	Dashboards
AI Assistance	AI Assistance