All Use Cases
Wojtek Bialek
What is Redash?
Redash is an open-source application used for visualizaing data from multiple datasources. It uses data source native languge for queries in order to extract data and use it's results for visualization. Redash also enables user to create dashboards from already created visualizations.
Connection requirements
- To connect to Redash there are no special requirements besides having account API key.
- To import all Redash object account from which API Key comes from, have to be added to all groups and have admin permisions. Otherwise only part of object will be properly improted
Connecting to Redash
Getting API Key from Redash
To get your Account API Key go to your profile, and copy it using build-in button.
Connecting in Dataedo
To connect to Redash create new documentation by clicking Add documentation and choosing New connection.
On the connection screen choose Redash.
Provide connection details:
- Host - provide a host name or address where a database is on. E.g. https://redash.com , https://server17.ourdomain.com.
- API Key- provide your account Api Key
Saving API Key
You can save API Key for later connections by checking Save API Key option. API Keys are saved in the repository database.
Importing objects
When connection was successful Dataedo will read objects and show a list of objects found. You can choose which objects to import. You can also use advanced filter to narrow down list of objects.
Confirm list of objects to import by clicking Next.
Next screen with allow you to change default name of the documentation under with your schema will be visible in Dataedo repository.
Click Import to start the import.
When done close import window with Finish button.
Your Redash has been imported to new documentation in the repository.
Importing changes
To sync any changes in the schema in Redash and reimport any technical metadata simply choose Import changes option. You will be asked to connect to Redash again and changes will be synced from the source.
Scheduling imports
You can also schedule metadata updates using command line files. To do it, after creating documentation use Save update command option. Downloaded file can be run in command line, what will reimport changes to your documentation.
Specification
Imported metadata
| Imported | Editable | |
|---|---|---|
| Queries | ✅ | ✅ |
| Query Description | ✅ | ✅ |
| Script | ||
| Columns | ✅ | ✅ |
| Data types | ✅ | |
| Nullability | ||
| Column comments | ✅ | |
| Visualizations | ✅ | ✅ |
| Visualization Description | ✅ | |
| URL | ✅ | |
| Columns | ✅ | |
| Data types | ✅ | |
| Column comments | ✅ | ✅ |
| Dashboards | ✅ | ✅ |
| Dashboard Description | ✅ | |
| URL | ✅ | |
| Columns | ✅ | |
| Data types | ✅ | |
| Column comments | ✅ | ✅ |
Supported features
| Feature | Imported |
|---|---|
| Import comments | ✅ |
| Write comments back | |
| Data profiling | |
| Reference data (import lookups) | |
| Importing from DDL | |
| Generating DDL | |
| FK relationship tester |
Comments
Dataedo reads comments from following Redash objects:
| Object | Read | Write back |
|---|---|---|
| Query comments | ✅ | |
| Visualization comments | ✅ | |
| Dashboard comments | ✅ |
Data Lineage
| Source | Method |
|---|---|
| Queries - object level | From API |
| Queries - column level | From API |
| Queries - column level | From SQL parsing |
| Visualizations - object level | From API |
| Visualizations - column level | From API |
| Visualizations - column level | From SQL parsing |
| Dashboards - object level | From API |
| Dashboards - column level | From API |
| Dashboards - column level | From SQL parsing |
Known issues and limitations
- Queries with parameters can sometimes not import columns