Skip to content

Commit

Permalink
docs - data reference updates (metabase#26772)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff-bruemmer authored Nov 28, 2022
1 parent ff4ae4f commit fe83648
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions docs/exploration-and-organization/data-model-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,33 @@ redirect_from:

# Data reference

Sometimes when you're composing a question, you might forget the exact names of different tables or columns, or which table contains what. That’s where the _data reference_ comes in handy. You can open the data reference from:
Sometimes when you're composing a question, you might forget the exact names of different tables or columns, or orwhiceh table contains what. That’s where the **Data reference** comes in handy.

You can open the data reference from:

- The Metabase sidebar > **Browse data** > **Learn about our data**.
- The SQL editor > **book** icon.

## Browse data reference

The data reference is a collection of pages organized by database, then tables (the same structure you use to [pick data](../questions/query-builder/introduction.md#picking-data)). This is the best place to find information about the [data types](https://www.metabase.com/learn/databases/data-types-overview) of columns in your data.
The data reference is a collection of pages organized by database, then tables in that database (the same structure you use to [pick data](../questions/query-builder/introduction.md#picking-data)). The data reference section is the best place to find information about the [data types](https://www.metabase.com/learn/databases/data-types-overview) of columns in your data.

![Data reference page](./images/data-reference-page.png)

## SQL editor data reference

This panel lists all the databases you have access to and the tables and columns inside of them.
This panel lists all the databases you have access to, and the [models](../data-modeling/models.md) and tables, and the fields inside of them.

![Data reference sidebar](./images/DataReference.png)

Click on the table you would like to explore further to see a description of it and a list of all the columns it has. Each table or column will only contain a description if your admin wrote something in the Data Model section of the Admin Panel.
Click on the model or table you would like to explore further to see a description of it and a list of all the columns it has. Each table or column will only contain a description if your admin wrote something in the Data Model section of the Admin Panel.

If you click on a column you’re interested in, you’ll see a description of its contents, as well as a list of sample values for columns that don't have a huge number of distinct values.

![Column detail](./images/data-reference-column-detail.png)
### Connections

![Connections](./images/connections.png)

## Foreign keys
In the data reference sidebar, under **Connections**, you can find a list of table relationships (defined by [foreign keys](https://www.metabase.com/glossary/foreign_key)).

You can find a list of table relationships ([foreign keys](https://www.metabase.com/glossary/foreign_key)) under **Connected to these tables**. If a Metabase admin has documented the relationship between your current table and another table in the database, Metabase will display this section in the sidebar. If a foreign key relationship exists in your database, but doesn't show up in your Metabase, your Metabase admin will need to update your [Metabase data model](../data-modeling/metadata-editing.md).
If a foreign key relationship exists in your database, but doesn't show up in your Metabase, your Metabase admin will need to update your [Metabase data model](../data-modeling/metadata-editing.md).
Binary file modified docs/exploration-and-organization/images/DataReference.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fe83648

Please sign in to comment.