DocumentDB

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in JetBrains Rider by default. If the relevant features are not available, make sure that you did not disable the plugin.

Press Ctrl+Alt+S to open settings and then select Plugins.
Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

Official documentation

For full information about DocumentDB, refer to the official documentation.

Before you begin

This topic presents a general procedure on how you can create a data source for the connection to your DocumentDB database in JetBrains Rider, and run a test connection. It is assumed that you already have the necessary connection details and the database is up and running.

For example, if you want to run a database on your machine and connect to that database, the corresponding DBMS software must be installed on the machine first.

To learn about your DBMS software, refer to its official documentation.

Connect to a DocumentDB database

In the Database tool window ( View | Tool Windows | Database) , click New and select Connect to Database.
If you have a connection string for the database defined in your solution or elsewhere, leave the Use connection string option selected and choose DocumentDB in the Database type selector.
Use the String selector to choose the desired connection string from your solution or type it in manually, then click Connect.
You can also choose Add data source manually, click Next and select DocumentDB in the Database source selector. Follow the wizard steps to form the connection string by configuring individual options.
To access all available options for the new database connection, click in the Database window, then click New and select DocumentDB.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
1. In the Driver list, leave the default driver option, unless another driver is required for your connection.
  For the DocumentDB driver, retryWrites=false, as the database service explicitly does not support retryable writes. For more information, refer to the DocumentDB official documentation.
2. From the Connection type list, select the connection type depending on the connection details that you have:
  - default: standard connection string format (for example, mongodb://localhost:27021/admin). Read more about standard connection string format in Standard Connection String Format at docs.mongodb.com.
  - URL only: connect by using only the URL.
  For the URL only connection type, the JDBC URL that you enter is used and as is, including the database credentials.
  For the URL only connection type, the JDBC URL is stored in plain text as is, and is also available in IDE log file and data source information.
  For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.
Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.
Location for the downloaded JDBC drivers is the JetBrains Rider configuration directory.
You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.
If there is no Download missing driver files link, then you already have the required drivers.
Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.
1. In the Host field, type your server address.
2. In the Port field, type the port of DocumentDB. The default port is 27017.
  Real port numbers might be different on your system. Verify that you use a correct port number with your database administrator, server settings, or hosting provider.
3. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - User & Password: by using your login and password.
  - MongoDB Authentication options:
    SCRAM-SHA-1: authenticate using User, Password, Authentication database and the SHA-256 hashing function.
    SCRAM-SHA-256: authenticate using User, Password, Authentication database and the SHA-1 hashing function.
    AWS IAM: authenticate using AWS access key id, AWS secret access key, and AWS session token.
    x.509: use x.509 certificate for authentication.
    GSSAPI (Kerberos): use Kerberos for authentication.
    Plain (LDAP): authenticate by proxying the authentication request to a Lightweight Directory Access Protocol (LDAP) service.
  - No auth: authentication is not required.
4. In the User and Password fields, type your user credentials.
  To use no password, leave the Password field empty.
  To delete a once entered password, right-click the Password field and select Set Empty.
5. In the Database field, type the database name to which you want to connect.
6. In the URL field, JetBrains Rider generates the JDBC URL automatically using the values of other connection settings.
  If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:
  - Format: mongodb://⋖host_address⋗:⋖port_number⋗/⋖database_name⋗
  - Example: mongodb://127.0.0.1:27017/myDatabase
  For more information about the URL format, refer to the DocumentDB official documentation.
1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - User & Password: by using your login and password.
  - MongoDB Authentication options:
    SCRAM-SHA-1: authenticate using User, Password, Authentication database and the SHA-256 hashing function.
    SCRAM-SHA-256: authenticate using User, Password, Authentication database and the SHA-1 hashing function.
    AWS IAM: authenticate using AWS access key id, AWS secret access key, and AWS session token.
    x.509: use x.509 certificate for authentication.
    GSSAPI (Kerberos): use Kerberos for authentication.
    Plain (LDAP): authenticate by proxying the authentication request to a Lightweight Directory Access Protocol (LDAP) service.
  - No auth: authentication is not required.
2. In the User and Password fields, type your user credentials.
  To use no password, leave the Password field empty.
  To delete a once entered password, right-click the Password field and select Set Empty.
3. In the URL field, JetBrains Rider generates the JDBC URL automatically using the values of other connection settings.
  If you need to use a JDBC URL with certain additional settings, paste it in the URL field.
  For more information about the URL format, refer to the DocumentDB official documentation.
  For the URL only connection type, the URL field contents are stored in plain text, and are also available in the IDE log file.
  Use the designated fields to provide your sensitive connection details instead of putting them into the URL field.
For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Shift+Enter) , see Connection settings and DBMS-specific properties.
Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.
In case of any connection issues, refer to the Cannot connect to a database page.
(Optional) By default, only the default database is introspected and available to work with. If you also want to work with other databases, in the Schemas tab, select them for the introspection.
Click OK to create the data source.
Find your new data source in the Database tool window (⌘ 1) .
- For more information about the Database tool window, see the corresponding reference topic.
  To see more databases under your new data source node, click the N of M button and select the ones you need. JetBrains Rider will introspect and show them.
- For more information about working with database objects in JetBrains Rider, refer to Database objects.
- To write and run queries, open the default query console by clicking the data source and pressing F4.
- To view and edit data of a database object, open Data editor and viewer by double-clicking the object.

Connection settings and DBMS-specific properties

Connection settings

For the reference information about connection settings (for example, Host, Port, and so on) on the General and other tabs of Data Sources and Drivers dialog (Shift+Enter) , see Data Sources.

DBMS-specific properties

General tab

Item	Description
Authentication database	Name of the authentication database that is associated with your username. If the authentication database differs from the database to which you want to connect, specify the authentication database with the `authSource` parameter in the URL. If no authentication database is specified, MongoDB uses the `admin` database by default. For example, you want to connect to the `local` database but your authentication database is `admin`. In this case, the connection URL will look like: `mongodb://localhost:27017/local?authSource=admin`. The property is used for the SCRAM-SHA-1 and SCRAM-SHA-256 authentication method.
AWS access key id	The connection properties used for the MongoDB AWS IAM authentication method.
AWS session token
AWS secret access key
Principal	The connection properties used for the MongoDB GSSAPI (Kerberos) authentication method. For more information, refer to MongoDB official documentation on this method.
Service name
Service realm
Canonicalize host name

Last modified: 15 November 2024