Connecting to a Yandex StoreDoc cluster from applications

You can connect to a Yandex StoreDoc cluster using command line tools, graphical IDEs, and Docker containers. To learn how to connect from your application code, see Code examples.

In the examples below, the root.crt SSL certificate is located in the following directory:

• ~/.mongodb/ for Ubuntu.
• $HOME\.mongodb for Windows.

If the connection to the cluster is successful and the test query is executed, the name of the database to which the connection was made will be displayed.

Command line toolsCommand line tools

To see code examples with the host FQDN filled in, open the cluster page in the management console and click Connect.

The setup method depends on whether cluster sharding is enabled:

Linux (Bash)Linux (Bash)

Before connecting, install the MongoDB Shell utility.

mongosh --norc \
        --tls \
        --tlsCAFile ~/.mongodb/root.crt \
        --host '<Yandex_StoreDoc_host_1_FQDN>:27018,...,<Yandex_StoreDoc_host_N_FQDN>:27018' \
        --username <DB_username> \
        --password <DB_user_password> \
        <DB_name>

mongosh --norc \
        --tls \
        --tlsCAFile ~/.mongodb/root.crt \
        --host '<MONGOINFRA_or_MONGOS_host_1_FQDN>:27017,...,<MONGOINFRA_or_MONGOS_host_N_FQDN>:27017' \
        --username <DB_username> \
        --password <DB_user_password> \
        <DB_name>

mongosh --norc \
        --ssl \
        --sslCAFile ~/.mongodb/root.crt \
        --host '<Yandex_StoreDoc_host_1_FQDN>:27018,...,<Yandex_StoreDoc_host_N_FQDN>:27018' \
        --username <DB_username> \
        --password <DB_user_password> \
        <DB_name>

mongosh --norc \
        --ssl \
        --sslCAFile ~/.mongodb/root.crt \
        --host '<MONGOINFRA_or_MONGOS_host_1_FQDN>:27017,...,<MONGOINFRA_or_MONGOS_host_N_FQDN>:27017' \
        --username <DB_username> \
        --password <DB_user_password> \
        <DB_name>

mongosh --norc \
        --host '<Yandex_StoreDoc_host_1_FQDN>:27018,...,<Yandex_StoreDoc_host_N_FQDN>:27018' \
        --username <DB_username> \
        --password <DB_user_password> \
        <DB_name>

mongosh --norc \
        --host '<MONGOINFRA_or_MONGOS_host_1_FQDN>:27017,...,<MONGOINFRA_or_MONGOS_host_N_FQDN>:27017' \
        --username <DB_username> \
        --password <DB_user_password> \
        <DB_name>

To learn how to get host FQDN, see this guide.

Once connected, run the db command.

Windows (PowerShell)Windows (PowerShell)

Before connecting, install the MongoDB Shell utility.

mongosh.exe --norc `
            --host '<Yandex_StoreDoc_host_1_FQDN>:27018,...,<Yandex_StoreDoc_host_N_FQDN>:27018' `
            --tls `
            --tlsCAFile $HOME\.mongodb\root.crt `
            --username <DB_username> `
            --password <DB_user_password> `
            <DB_name>

mongosh.exe --norc `
            --host '<MONGOINFRA_or_MONGOS_host_1_FQDN>:27017,...,<MONGOINFRA_or_MONGOS_host_N_FQDN>:27017' `
            --tls `
            --tlsCAFile $HOME\.mongodb\root.crt `
            --username <DB_username> `
            --password <DB_user_password> `
            <DB_name>

mongosh.exe --norc `
            --host '<Yandex_StoreDoc_host_1_FQDN>:27018,...,<Yandex_StoreDoc_host_N_FQDN>:27018' `
            --username <DB_username> `
            --password <DB_user_password> `
            <DB_name>

mongosh.exe --norc `
            --host '<MONGOINFRA_or_MONGOS_host_1_FQDN>:27017,...,<MONGOINFRA_or_MONGOS_host_N_FQDN>:27017' `
            --username <DB_username> `
            --password <DB_user_password> `
            <DB_name>

To learn how to get host FQDN, see this guide.

Once connected, run the db command.

Connecting from graphical IDEsConnecting from graphical IDEs

Connections were tested in the following environment:

• MacOS Big Sur 11.3
• JetBrains DataGrip: 2021.1
• DBeaver Enterprise: 21.0

You can only use graphical IDEs to connect to public cluster hosts with an SSL certificate.

To avoid connection errors, save the certificate to a local folder that does not require administrator rights to access.

DataGripDataGrip

1. Create a data source:
   1. Select File → New → Data Source → MongoDB.
   2. On the General tab:

      1. Configure the connection as follows:

         • User, Password: DB user name and password.

         • URL: Connection string.

           For a non-sharded cluster:

           mongodb://<Yandex_StoreDoc_host_1_FQDN>:27018,..,<Yandex_StoreDoc_host_N_FQDN>:27018/<DB_name>
           

           For a sharded cluster:

           mongodb://<MONGOINFRA_or_MONGOS_host_1_FQDN>:27017,...<MONGOINFRA_or_MONGOS_host_N_FQDN>:27017/<DB_name>
           

           To learn how to get host FQDN, see this guide.

      2. Click Download to download the connection driver.

   3. On the SSH/SSL tab:
      1. Enable Use SSL.
      2. In the CA file field, specify the path to the file with an SSL certificate for the connection.
2. Click Test Connection. If the connection is successful, you will see the connection status and information about the DBMS and driver.
3. Click OK to save the data source.

DBeaverDBeaver

Connections to Yandex StoreDoc clusters are only available in DBeaver business editions.

To connect to your cluster:

1. Create a new DB connection:
   1. In the Database menu, select New connection.
   2. Select MongoDB from the DB list.
   3. Click Next.
   4. Specify the connection parameters on the Main tab:

      1. Under Address, change Type to URL and specify the connection string.

         For a non-sharded cluster:

         mongodb://<Yandex_StoreDoc_host_1_FQDN>:27018,..,<Yandex_StoreDoc_host_N_FQDN>:27018/<DB_name>
         

         For a sharded cluster:

         mongodb://<MONGOINFRA_or_MONGOS_host_1_FQDN>:27017,...<MONGOINFRA_or_MONGOS_host_N_FQDN>:27017/<DB_name>
         

         To learn how to get host FQDN, see this guide.

      2. In the Device list, select SCRAM-SHA-256 (type of password encryption when connecting to the DB).

      3. Under Authentication, specify the DB username and password.

   5. On the SSL tab:
      1. Enable Use SSL.
      2. In the Root certificate field, specify the path to the saved SSL certificate file.
      3. Under Settings, select Skip hostname validation.
2. Click Test connection .... If the connection is successful, you will see the connection status and information about the DBMS and driver.
3. Click Ready to save the database connection settings.

Before you connect from a Docker containerBefore you connect from a Docker container

To connect to a Yandex StoreDoc cluster from a Docker container using SSL, add the following lines to the Dockerfile:

RUN apt-get update && \
    apt-get install wget --yes && \
    mkdir --parents ~/.mongodb && \
    wget "https://storage.yandexcloud.net/cloud-certs/CA.pem" \
         --output-document ~/.mongodb/root.crt && \
    chmod 0644 ~/.mongodb/root.crt

To connect without SSL, no additional Dockerfile settings are required.

After you run the Docker container, navigate to it and install mongosh. You will need it to connect to the cluster.