DocumentDB

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

note

The Database Tools and SQL plugin is available only in PyCharm Professional.

1. Press CtrlAlt0S to open settings and then select Plugins.

2. Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

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

1. To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:

   • In the main menu, go to File | New | Data Source and select DocumentDB.

   • In the Database tool window (View | Tool Windows | Database) , click the New icon () in the toolbar. Navigate to Data Source and select DocumentDB.

   

2. 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.

      note

      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.

      note

      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.

   

3. 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 PyCharm 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.

4. Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.

   default

   URL only

   1. In the Host field, type your server address.

   2. In the Port field, type the port of DocumentDB. The default port is 27017.

      note

      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, PyCharm 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, PyCharm 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.

      warning

      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 (CtrlAltShift0S) , see Connection settings and DBMS-specific properties.

5. 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.

6. (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.

   

7. Click OK to create the data source.

8. Find your new data source in the Database tool window () .

   • For more information about the Database tool window, see the corresponding reference topic.

     tip

     To see more databases under your new data source node, click the N of M button and select the ones you need. PyCharm will introspect and show them.

     

   • For more information about working with database objects in PyCharm, 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.