Skip to content
Snippets Groups Projects
GETTINGSTARTED.md 1.92 KiB
Newer Older
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed
# Before you start

Sameer Al-Sakran's avatar
Sameer Al-Sakran committed
This guide assumes you have a database you have access to and it is set up correctly. If not, please follow the instructions in the [Installation Guide](INSTALLATION.md)
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed

# Understanding what data you have
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed

Initially, let's see what data you have available. The Explore section of the app allows you to see which tables you have available, look at all the rows in a given table, and drill down to individual rows. 

Sameer Al-Sakran's avatar
Sameer Al-Sakran committed
* Click `explore`
* Note that all of your tables are there
* Click on one
* Note the pagination
* Try getting the next page
* Note that you can filter these pages
* Try to filter by a column
* if it’s a date
* if it’s a category
* Note that any IDs or Foreign keys are clickable
* Click on one
* Note that all fields are present
* We can click on any FKs
* Any urls are clickable
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed
* Note the `Linked Entites` on the bottom
* Click on one of these and note that below are a bunch of that entities linked objects

# Asking a Question
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed

When you have a specific question you are trying to answer, you can use the Card section of the application. Here you can ask a specific question of a given table of data you have. We'll start with the simplest possible question you can ask, "How many X are there?".

Sameer Al-Sakran's avatar
Sameer Al-Sakran committed
* Click `Cards`
* Click `Create New`
* Select a database
* if you only have a single database, this step happens automatically
* Select a table
* See the bare rows
* click run
* note that this allows you to see all of the rows in a table
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed
* Select `total count`

# Saving a Question to a Dashboard
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed

Assuming this is something you'll want to keep tabs on regularly, or share regularly, you can add it to a dashboard. Dashboards are collections of questions you have saved that you expect to look at as a group or that everyone in your organization can look at. 

* Save
* Add it to a dashboard
* Give it a name

* Go to your newly created dashboard
Sameer Al-Sakran's avatar
Sameer Al-Sakran committed
* click `Dashboards`
* click your new dashboard
* Note that your card is there