Icon

How to Review Database Table Documentation: A Step-by-Step Guide

Learn how to review and understand documentation for tables in your database, including how to view table details, fields, dependencies, and creation code. Follow this step-by-step guide to navigate your data reference page efficiently.

By Robin Neri

In this guide, we'll learn how to explore the documentation for tables in a database. Understanding this process helps you find details about each table, its fields, and how tables are connected or created. You will also see how to access the code and data sources behind each table.

Let's get started

This is an overview of how to review the documentation for tables in the database. We begin on the data reference page, where we can view and select a database. Click on "Tables" within the database, then choose the table you want. For example, click on the desired table.

2
Click on the database to view (table names or version numbers may be different in your view)
Step #2: Click on the database to view (table names or version numbers may be different in your view)
3
Click on "Tables in [the database]"
Step #3: Click on "Tables in [the database]"

Here are the details and a description of each table.

4
Select a table to see more information about that table.
Step #4: Select a table to see more information about that table.

Click on "Fields in this table" to view the list of columns, including their names, descriptions, field types, and data types.

5
Click here
Step #5: Click here

You can click on one of these to view more information about the field, including the column name in the database, which may differ from the display name on the platform.

6
Select a Field (aka a column) to see more information
Step #6: Select a Field (aka a column) to see more information
7
This view will also show you the name of the column in the database, and other information.
Step #7: This view will also show you the name of the column in the database, and other information.

The table description includes a link to more details about how the table was created.

We can follow the link to view more information about the table.

8
Go to the table's url in the data processing documentation site
Step #8: Go to the table's url in the data processing documentation site
9
Table names here match the table names in the Metabase platform
Step #9: Table names here match the table names in the Metabase platform

This shows which tables were used to create the current table. Clicking on "Depends On" displays all other tables involved in its creation.

We can click on these to view details about the tables. We can also view and inspect the code used to create this table. This can be done for any table in the database. How these tables are linked, created, and which data sources they use are all explained in this documentation.