A Complete Guide to Managing MongoDB Queries in Studio 3T

Introducing Team Sharing and shared folders

Do you want to collaborate on MongoDB queries with other team members? With Studio 3T’s Team Sharing you can create private folders so that you can share queries with other Studio 3T users. Choose queries to add to the shared folders. Your colleagues can modify and save them, making them available to everyone.

Query Manager keeps track of all your MongoDB queries in Studio 3T and allows you to organize your queries and scripts into folders.

You can access Query Manager from the Collection Tab, IntelliShell, SQL Query, the Aggregation Editor, or the My resources sidebar.

Displaying the Query Manager

To display the Query Manager, click Load Query and select Open Query Manager from the list.

The Query Manager displays a list of all your saved queries, grouped into folders. Local Resources are queries that are saved on your local machine.

A Query Manager tab showing a list of saved MongoDB queries, organised into folders

To filter the list of queries:

select the folder name in the Show Queries from list to display queries from a single folder.

use the search bar to type in the name of the query. The query list is filtered as you type, so you don’t need to know the exact name.

The Query preview panel at the bottom of the Query Manager shows the query details for the selected query.

Working with folders

You can organize your queries by creating folders and then dragging and dropping queries to the required location.

To add a folder, click New folder and type the folder name in the Add Query folder dialog.

Working with shared folders

You can create shared folders so that you can share MongoDB connections, SQL connections, queries, and scripts with other team members that are Studio 3T users.

To add a shared folder, click New shared folder.

The first page of the Create new shared folder dialog where you can specify the people you want to share the folder with.

In the Create new shared folder dialog, type the name of the folder in the Enter a name for the shared folder box.

Type or select the email address of the person you want to share the folder with in the Invite other people to join this folder box, and click Invite person. For each person that you add, choose their level of access: Manage, Edit, or View. Click Next.

The second page of the Create new shared folder dialog where you can choose the MongoDB or SQL connections, queries, and scripts that you want to share.

On the next page of the dialog, use the checkboxes to select the resources you want to share:

connections
SQL connections
queries or scripts

When you have finished choosing resources, click Create. You’ll get a notification in Studio 3T informing you that your shared folder has been created. Invited team members will receive a notification to join the shared folder.

Creating a query

To quickly create a MongoDB query, SQL Query, or script:

1. Click New query.

2. In the Add new query dialog, type a name for the query in the Query name box.

3. In the Location list, select the folder where you want to save your query.

4. In the Query type list, choose from Collection query, IntelliShell script, SQL Query, or Aggregation query.

5. In the Query target box, click Select target if you want to associate a query with a particular database and collection name.

6. Type your query or script in the box.

If you are writing a collection query, Projection, Sort, Skip, and Limit boxes are displayed for you to further refine your query.

7. When you have finished writing your query, click Save.

Studio 3T offers various tools for creating queries, both simple and complex:

Visual Query Builder and the AI Helper speed up the process of writing MongoDB queries and aggregations.
IntelliShell offers smart auto-completion and error tracking as you code.
The Aggregation Editor shows input data and output data for each stage in your aggregation.

Loading and running a query

To run a query:

1. Double-click it or click Load.

2. In the Load query dialog, select the collection (or database if it’s a SQL Query) where you want to run the query, and click Open.

Studio 3T runs the query and displays the results in a new Collection Tab (or SQL tab).

To run a script:

1. Double-click it or click Load.

2. In the Load script dialog, select the server, database or collection where you want to run the script, and click Open.

Studio 3T runs the script and displays the results in a new IntelliShell Tab.

Editing a query

To quickly edit a query or script:

1. Select it and click Quick edit.

2. In the Edit query or Edit script dialog, make the required changes and click Save.

Duplicating a query

To duplicate a query:

Select the query and click Duplicate.

The new query is displayed in the list with (1) appended to its name. Whenever you duplicate a query, its name will always be unique. You can rename a query by right-clicking and selecting Rename.

Deleting a query

To delete a query:

Select the query and click Delete.

FAQs about MongoDB queries

How do I view my query history?

Whenever you run a query or script in Studio 3T, it is automatically saved. To view your query history, click Query history in the toolbar in the Collection Tab, SQL Query, or Aggregation Editor. To view your script history, click Script history in the IntelliShell toolbar.

You can search through your history, save an item as a query or script so that you can use it again in Studio 3T, or load the item ready for use in the tab from which you opened the history, and more.

How do I save a query?

Run a query in the Collection Tab, SQL Query, or the Aggregation Editor, and click Save query. In the Save query dialog, type a name for the query, and click Save. The Save query dialog also allows you to:

specify the folder where you want to save your query, and if required you can create new folders
specify a shared folder, and optionally make the query read-only to all users except for the user applying the lock
associate the query with a connection, database, and collection or view name (see How do I save target details?)

In IntelliShell, run your query or script and click Save script. The Save script dialog is displayed and works in the same way as the Save query dialog.

How do I save target details?

You can store the associated connection, database, and collection or view name when you save a query (or the associated connection and database when you save a script). To do this, on the Save query or Save script dialog in the Collection Tab, SQL Query, Aggregation Editor, or IntelliShell, select the Save target details checkbox. Or, in the Query Manager click Select target in the Query target box.

You’ll see the stored database name and collection name when you:

load a query or script in the Collection Tab, SQL Query, Aggregation Editor, or IntelliShell
select the query or script in the Query Manager and look at the Query preview section

To change or remove the saved target details, you’ll need to edit the query or script. To change the details, click Change target or to remove the details, click the arrow and select Remove query target.

Change the database or collection that your MongoDB query is associated with

How do I set a default query?

For every collection, you can specify a query that is automatically loaded and run whenever you open a new Collection Tab for that collection. To set the default query for a collection, in the Collection Tab toolbar, click Set default query.