Skip to content
Studio 3T - The professional GUI, IDE and client for MongoDB
  • Tools
    • Aggregation Editor
    • IntelliShell
    • Visual Query Builder
    • Export Wizard
    • Import Wizard
    • Query Code
    • SQL Query
    • Connect
    • Schema Explorer
    • Compare
    • SQL ⇔ MongoDB Migration
    • Data Masking
    • Task Scheduler
    • Reschema
    • More Tools and Features
  • Solutions
  • Resources
    • Knowledge Base
    • MongoDB Tutorials & Courses
    • Tool/Feature Documentation
    • Blog
    • Community
    • Testimonials
    • Case Studies
    • Whitepapers
    • Reports
  • Contact us
    • Contact
    • Sales Support
    • Feedback and Support
    • Career
    • About Us
  • Store
    • Buy Now
    • Preferred Resellers
    • Team Pricing
  • My License
  • Download
search

Studio 3T Knowledge Base

  • Documentation
  • Tutorials
  • Workshops
Take the fastest route to learning MongoDB. Cover the basics in two hours with MongoDB 101, no registration required.
Start the free course

Connection Tree Metadata: Aliases and Notes

Posted on: 21/07/2022 by DJ Walker-Morgan

Studio 3T 2022.7 and later supports the creation and display of metadata – aliases and notes – for items in the Connection Tree. It allows items in the tree to have an alternative name (alias) and have text, such as documentation, attached to it (notes). 

You can only create aliases and notes for:

  • Databases
  • Collections
  • Views
  • GridFS Buckets

Connections already have a user customizable name, editable in the Connection Manager.

Aliases

An alias is a preferred alternate name for a collection, view, or database. An alias will display in place of the actual name (which will then display in parentheses after the alias name). Aliases allow a user to customize how Studio 3T presents connection tree items to them. 

How a Studio 3T Metadata alias appears in the connection tree
An aliased collection

Showing an alias “cheese vending” for the collection cheeseshop.

Note that although a database, collection,  view or bucket may have an alias, when addressing it in IntelliShell, you need to use the actual name, not the alias.

In the connection tree, items are arranged in alphabetical order. Setting an alias on either will see that alias used (instead of the actual name) to arrange the tree.

Adding an Alias

To add an Alias on a Connection Tree item, select the item in the tree and then use the right-click menu and move to Manage Metadata:

The Manage Metadata Menu for items with no alias or note

This menu changes according to the current state of the item. Where the item does not have an alias, the menu will show Add Alias. Select this item to display the Add Alias dialog:

Adding an alias

Enter your desired alias and click OK.

Once an Alias has been created for an item, you can bring up the Manage Metadata menu to select other options:

The Manage Metadata menu for an item with just an alias

Edit Alias

Select Edit Alias from the Manage Metadata menu to display the Edit Alias dialog. 

Editing an alias

Change the alias in the text field and click OK to update the alias. 

Remove Alias

Selecting Remove Alias from the Manage Metadata menu will immediately remove the alias from the item in the connection tree.

Copy Alias

To copy the text of an alias, select Copy Alias from the Manage Metadata menu. This will copy only the text of the alias to the clipboard, in the same way as the Copy Name menu option in the right-click menu will copy the connection tree item’s actual name to the clipboard.

Alias Tips

Emoji in Aliases

Aliases can include emojis

Aliases can use emoji to add visual significance to an aliased item. While it is possible to use emoji in the actual names of databases, collections, and views, those emoji have to be escaped when using the item in IntelliShell, making scripts harder to read. By using the alias for emoji enhanced presentation, you can continue to use the easier to read actual name in scripts.

Notes

Notes provide the opportunity to append a free-form block of text to an eligible item. While aliases change the presentation of a collection, view or database in the connection tree, adding a note to one of these elements only shows as a notepad icon next to the item:

A note is attached to the cheeseshop collection

When you hover over an item with a notepad icon, the tooltip will include the text from the note as well as the usual statistics for that collection, view, or database.

Hovering reveals the collection statistics and note (and alias)

Adding a Note

To add an Note on a Connection Tree item, select the item in the tree and then use the right-click menu and move to Manage Metadata:

The Manage Metadata menu with no alias on note – select Add Note

This menu changes according to the current state of the item. Where the item does not have a note, the menu will show Add Note. Select this item to display the Add Note dialog:

Adding a note allows for up to 2000 characters per note

Once a Note has been created for an item, you can bring up the Manage Metadata menu to select other options:

The Manage Metadata menu where the item only has a note

Edit Note

Select Edit Note from the Manage Metadata menu to display the Edit Note dialog. You can change the text and save it by clicking Ok.

Editing a note

Remove Note

Selecting Remove Note from the Manage Metadata menu will immediately remove the note from the item in the connection tree.

Copy Note

To copy the text of a note, select Copy Note from the Manage Metadata menu. This will copy only the text of the note to the clipboard so you can paste it elsewhere.


How helpful was this article?
This article was hideous
This article was bad
This article was ok
This article was good
This article was great
Thank you for your feedback!

About The Author

DJ Walker-Morgan

Dj has been around since Commodore had Pets and Apples grew everywhere. With a background in Unix and development, he's been around the technology business writing code or writing content ever since.

Article navigation

Related articles

  • What’s New in Studio 3T 2022.7 – Aliases and Notes
  • Connection Manager
  • What’s New in Studio 3T 2020.3 | Improvements to Session Restore, Connection Manager & More
  • What’s New in Studio 3T 2022.1 – SQL Connection Import/Export, MongoDB-AWS authentication
  • What is the fastest way to make a database connection? #Studio3T_AMA

Studio 3T

MongoDB Enterprise Certified Technology PartnerSince 2014, 3T has been helping thousands of MongoDB developers and administrators with their everyday jobs by providing the finest MongoDB tools on the market. We guarantee the best compatibility with current and legacy releases of MongoDB, continue to deliver new features with every new software release, and provide high quality support.

Find us on FacebookFind us on TwitterFind us on YouTubeFind us on LinkedIn

Education

  • Free MongoDB Tutorials
  • Connect to MongoDB
  • Connect to MongoDB Atlas
  • Import Data to MongoDB
  • Export MongoDB Data
  • Build Aggregation Queries
  • Query MongoDB with SQL
  • Migrate from SQL to MongoDB

Resources

  • Feedback and Support
  • Sales Support
  • Knowledge Base
  • FAQ
  • Reports
  • Case Studies
  • White Papers
  • Testimonials
  • Discounts

Company

  • About Us
  • Blog
  • Careers
  • Legal
  • Press
  • Privacy Policy
  • EULA

© 2022 3T Software Labs GmbH. All rights reserved.

  • Privacy Policy
  • Cookie settings
  • Impressum
When you click "Accept", you are agreeing to cookies being on your device. They may improve site navigation, site usage analysis, or the relevance of messages. It is up to you which cookies are enabled. Read our Privacy Policy.
Manage cookies
Accept
✕

Privacy Preference Center

A cookie is a small file of letters and numbers that is downloaded on to your computer when you visit a website. Cookies are used by many websites and can do a number of things, eg remembering your preferences, recording what you have put in your shopping basket, and counting the number of people looking at a website. In the form below you can choose which cookies, except for essential cookies, to allow or disable.

Accept all cookies

Manage consent preferences

Essential cookies are strictly necessary to provide an online service such as our website or a service on our website which you have requested. The website or service will not work without them.

Performance cookies allow us to collect information such as number of visits and sources of traffic. This information is used in aggregate form to help us understand how our websites are being used, allowing us to improve both our website’s performance and your experience.

Functional cookies collect information about your preferences and choices and make using the website a lot easier and more relevant. Without these cookies, some of the site functionality may not work as intended.

Social media cookies are cookies used to share user behaviour information with a third-party social media platform. They may consequently effect how social media sites present you with information in the future.

Accept selected