Connection Manager

Create a new connection

1. Open Studio 3T.
2. Click on the Connect button either in the global toolbar or under the Recent Connections tab. This will open the Connection Manager.
3. Click on New Connection. This will open the New Connection window.

Two ways to connect to MongoDB

Studio 3T provides two convenient ways to enter connection details: by pasting a MongoDB connection string or URI (recommended) or importing a URI file.

Use a MongoDB URI

Hosters like MongoDB Atlas, Compose, mLab, ObjectRocket, and ScaleGrid provide the MongoDB URI or connection string in an easy format, so all that’s left is to paste it within Studio 3T’s Connection Manager.

Picking up from the steps above:

1. Click on the From URI button.
2. Paste the connection string.
3. Click OK. Studio 3T will then extract the information and automatically fill out the fields in the Server, Authentication, SSL, SSH Tunnel, and Advanced tabs. It will also automatically save the connection in the Connection Manager.

Import a URI file

To import a URI file:

1. Click on the Connect button either in the global toolbar or under the Recent Connections tab.
2. Then, click on the Import button.
3. Click on Open Connection URI File.
4. Choose your .uri file and click Import.

Configure your MongoDB connection

You can configure your MongoDB connection settings further under the Server, Authentication, SSL, SSH Tunnel, Proxy, and Advanced tabs.

Server

1. Enter Connection Name – Name your connection.
2. Add Custom Color – Color-code your connection (e.g. to avoid production and test database mixups).
3. Choose Connection Type – Choose from Direct Connection, or Replica Set or Sharded Cluster.

4. Enter Server Details – Enter server hostnames or IP addresses and port details.

   When choosing Replica Set or Sharded Cluster, you can also set your Read Preference to Primary, Primary Preferred, Secondary, Secondary Preferred, or Nearest:
   

5. Enable/Disable Read Only Lock – Enables/disables read-only mode for the results shown in the connection you’re about to set up.
6. From URI – Import or paste the MongoDB connection string or URI (e.g. from your MongoDB hosting provider) here.

7. To URI – Export your connection details to a MongoDB URI, with the option to include passwords and add a replica set option.

   

8. Test Connection – Test connection details before saving. This button is accessible across all tabs.

Authentication

Studio 3T supports these authentication methods:

• None
• Basic (SCRAM-SHA-256)
• Legacy (SCRAM-SHA-1)
• X.509
• Kerberos (GSSAPI) – Enterprise only
• LDAP (Plain) – Enterprise only

Basic and Legacy authentication cover most cases.

1. Authentication Mode – Choose your authentication mode.
2. User Name – Enter your user name.

3. Password – Enter your password.

   Passwords are encrypted for storage. Leave the field blank if you prefer not to store your password, you will then be prompted to enter it later when you try to connect to the server.

4. Authentication DB – Enter the database where the user is defined.
5. Manually list visible databases – In most cases, Studio 3T will automatically list the databases that should be visible to non-admin uses. In some cases when this information isn’t available, you can check the box and manually specify them here.

SSL

1. Check the Use SSL protocol to connect box to connect over SSL. From here, you can choose to…
2. Accept any server SSL certificates – This normally covers most use cases.
3. Use own Root CA file – Locate the –sslCAFile on your machine.
4. Accept server SSL certificates trusted by the operating system
5. Use client certificate – Enter your client certificate and passphrase.
6. Allow invalid hostnames – Disables the validation of hostnames in TSL/SSL certificates.
7. Use Server Name Indication (Advanced) – Some servers may require the client to specify the server name it’s trying to connect to. If so, fill out this field so that the server can present one of the many SSL certificates.

SSH Tunnel

Check the Use SSH tunnel to connect box if applicable and fill out the fields:

• SSH Address
• Port
• SSH User Name
• SSH Auth Mode
• SSH Password – Note that passwords are encrypted for storage. If you don’t want to store your password, leave the field blank and you’ll be prompted to enter it later.

Proxy

You can use Studio 3T to connect using:

• Application default proxy
• Custom proxy (HTTP and SOCKS) – These HTTP and SOCKS custom proxy settings are available when connecting to MongoDB databases, connecting to SQL databases for import, and for application-run HTTPS requests (e.g. Telemetry).
• Direct/no proxy

Advanced

You can also configure advanced settings like:

• Max connection idle time (in ms) – Sets the maximum idle time in milliseconds for a connection. In some cases, the connection could be dropped by a firewall or a load balance. Here’s a little tip to prevent a connection timeout. Default value of “0” means unlimited idle time.
• Server selection timeout (in ms) – Defines how long Studio 3T will wait for server selection to succeed before throwing an exception.Default value is 30000. A value of 0 means it will time out immediately if no server is available. A negative value means it will wait indefinitely.
• Socket timeout (in ms) – Sets the socket timeout in milliseconds. It is used for I/O socket read and write operations. Default value is “0” and means no timeout.
• Connect timeout (in ms) – Sets the connection timeout in milliseconds, used solely when establishing a new connection. A value of “0” means no timeout. Default value is 10000.