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

AMA: How do I start sharing schemas with Studio 3T?

Posted on: 16/02/2022 (last updated: 22/02/2022) by DJ Walker-Morgan

Q: We’re working on reorganizing our database schemas. I need to start sharing schemas with my co-workers. Is there a way to do that with Studio 3T? 

Welcome to the latest Studio 3T Ask Manatees Anything – #Studio3T_AMA. Want to know how to use Studio 3T to make your MongoDB life better? Just tweet and use #Studio3T_AMA or email [email protected].

A: Of course. Studio 3T’s Schema Explorer isn’t just an interactive way to dig into how your MongoDB data is structured. It’s got the ability to share that information too. If we run Schema Explorer over a collection, we’ll get a distribution breakdown like this:

The Schema Explorer generates schema information you will want to share
The Schema Explorer breaking it all down for you

You can see how the documents aren’t consistent in what fields appear across the board. We’ve asked it to dig deeper into the arrays in there so we can get an idea of what is being stored there too. Arrays can hold multiple different types of data and assumptions about what types are there can trigger all sorts of errors when you are processing documents. This is all great information, but how do you share it?.

Documentation – The Key To Sharing Schemas

Look up at the tool bar for the Schema Explorer and you’ll find the Generate Documentation button.

The generate documentation button is the key to schema sharing
Locating the Generate Documentation button

This can turn the Schema report into documentation. Click it and up comes this dialog:

Note the Output Format button is a choice in Generate Documentation.
By default, the Generate Documentation button makes Word/.docx files

Which doesn’t look too promising for sharing. This is super useful for reporting as it pulls every chart, statistic and your comments into a single Word document /.docx document. It effectively makes a reference book for the explored Schema.

But that’s not ideal for all collaboration. Often you will want a more compact view for people to comment and collaborate on. That’s where the second output format comes in. Selecting CSV (.csv) as the format produces a much more compact file with the field name, probability, count, kind, type and comments in each row. If you’ve included array elements, they’ll be listed in there too. 

And as a CSV file, it’s quick to import into something like Google Sheets or other collaboration tools and in seconds have spreadsheet like this to share and work with:

A CSV file enables schema sharing with tools like Google Sheets.
A shared schema spread sheet ready for comments and notes

Schema Saving

If your colleagues have Studio 3T on their desktop, do remember you can save the results of a Schema Explorer analysis, complete with your comments, and send them the file which they can load into their desktop and continue analysis (providing they have access to the source database).

Where they don’t have Studio 3T or access to the databases in question, sharing via CSV sourced Spreadsheets and Word/DocX reference files is a great way to get the information out there.


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.

Related articles

  • AMA: Do you have any shortcuts to Studio 3T productivity?
  • AMA: How can Studio 3T’s Tasks make me more efficient?
  • What’s New in Studio 3T 2020.10 | Data Masking, Reschema & The Fastest Studio 3T Version Yet
  • Introduction to MongoDB and Studio 3T
  • Exercise: Installing Studio 3T

Tags

academy aggregation AMA atlas community connections date tags events export features hackolade import intellishell JSON knowledge base migration modelling mongodb mongoodb productivity query regex releases schema security SQL Studio 3T tasks tips updates webinar windows

Browse by MongoDB topic

  • Connecting to MongoDB
  • Database Administration & Security
  • Getting Started with MongoDB
  • Getting Started with Studio 3T
  • Import/Export
  • Job Automation & Scheduling
  • MongoDB Aggregation Framework
  • MongoDB/Studio 3T Workshops
  • Performance
  • Query & CRUD Operations
  • Reference
  • Schema
  • Studio 3T Licensing
  • Support and other resources
  • Working with MongoDB & SQL
  • Working with MongoDB Atlas

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