Skip to main content

Redash

Overview​

Redash is a business intelligence and analytics platform. Learn more in the official Redash documentation.

The DataHub integration for Redash covers BI entities such as dashboards, charts, datasets, and related ownership context. Depending on module capabilities, it can also capture features such as lineage, usage, profiling, ownership, tags, and stateful deletion detection.

Concept Mapping​

While the specific concept mapping is still pending, this shows the generic concept mapping in DataHub.

Source ConceptDataHub ConceptNotes
Platform/account/project scopePlatform Instance, ContainerOrganizes assets within the platform context.
Core technical asset (for example table/view/topic/file)DatasetPrimary ingested technical asset.
Schema fields / columnsSchemaFieldIncluded when schema extraction is supported.
Ownership and collaboration principalsCorpUser, CorpGroupEmitted by modules that support ownership and identity metadata.
Dependencies and processing relationshipsLineage edgesAvailable when lineage extraction is supported and enabled.

Module redash​

Incubating

Important Capabilities​

CapabilityStatusNotes
Detect Deleted Entities✅Enabled by default via stateful ingestion.
Table-Level Lineage✅Enabled by default.

Overview​

The redash module ingests metadata from Redash into DataHub. It is intended for production ingestion workflows and module-specific capabilities are documented below.

Prerequisites​

Before running ingestion, ensure network connectivity to the source, valid authentication credentials, and read permissions for metadata APIs required by this module.

Install the Plugin​

pip install 'acryl-datahub[redash]'

Starter Recipe​

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
  type: "redash"
  config:
    connect_uri: http://localhost:5000/
    api_key: REDASH_API_KEY

    # Optionals
    # api_page_limit: 1 #default: None, no limit on ingested dashboards and charts API pagination
    # skip_draft: true  #default: true, only ingest published dashboards and charts
    # dashboard_patterns:
    #   deny:
    #     - ^denied dashboard.*
    #   allow:
    #     - .*allowed dashboard.*
    # chart_patterns:
    #   deny:
    #     - ^denied chart.*
    #   allow:
    #     - .*allowed chart.*
    # parse_table_names_from_sql: false

Config Details​

Note that a . is used to denote nested fields in the YAML recipe.

FieldDescription
api_key
string(password)
Redash user API key.
Default: **********
api_page_limit
integer
Limit on number of pages queried for ingesting dashboards and charts API during pagination.
Default: 9223372036854775807
connect_uri
string
Redash base URL.
Default: http://localhost:5000
page_size
integer
Limit on number of items to be queried at once.
Default: 25
parallelism
integer
Parallelism to use while processing.
Default: 1
parse_table_names_from_sql
boolean
See note below.
Default: False
skip_draft
boolean
Only ingest published dashboards and charts.
Default: True
env
string
Environment to use in namespace when constructing URNs.
Default: PROD
chart_patterns
AllowDenyPattern
A class to store allow deny regexes
chart_patterns.ignoreCase
One of boolean, null
Whether to ignore case sensitivity during pattern matching.
Default: True
chart_patterns.allow
array
List of regex patterns to include in ingestion
Default: ['.*']
chart_patterns.allow.string
string
chart_patterns.deny
array
List of regex patterns to exclude from ingestion.
Default: []
chart_patterns.deny.string
string
dashboard_patterns
AllowDenyPattern
A class to store allow deny regexes
dashboard_patterns.ignoreCase
One of boolean, null
Whether to ignore case sensitivity during pattern matching.
Default: True
dashboard_patterns.allow
array
List of regex patterns to include in ingestion
Default: ['.*']
dashboard_patterns.allow.string
string
dashboard_patterns.deny
array
List of regex patterns to exclude from ingestion.
Default: []
dashboard_patterns.deny.string
string
stateful_ingestion
One of StatefulIngestionConfig, null
Stateful Ingestion Config
Default: None
stateful_ingestion.enabled
boolean
Whether or not to enable stateful ingest. Default: True if a pipeline_name is set and either a datahub-rest sink or datahub_api is specified, otherwise False
Default: False

Capabilities​

Use the Important Capabilities table above as the source of truth for supported features and whether additional configuration is required.

Chart lineage​

The integration can use an SQL parser to try to parse the tables the chart depends on. This parsing is disabled by default, but can be enabled by setting parse_table_names_from_sql: true. The parser is based on the sqlglot package.

Limitations​

Module behavior is constrained by source APIs, permissions, and metadata exposed by the platform. Refer to capability notes for unsupported or conditional features.

Troubleshooting​

If ingestion fails, validate credentials, permissions, connectivity, and scope filters first. Then review ingestion logs for source-specific errors and adjust configuration accordingly.

Code Coordinates​

  • Class Name: datahub.ingestion.source.redash.RedashSource
  • Browse on GitHub
Questions?

If you've got any questions on configuring ingestion for Redash, feel free to ping us on our Slack.

💡 Contributing to this documentation

This page is auto-generated from the underlying source code. To make changes, please edit the relevant source files in the metadata-ingestion directory.

Tip: For quick typo fixes or documentation updates, you can click the ✏️ Edit icon directly in the GitHub UI to open a Pull Request. For larger changes and PR naming conventions, please refer to our Contributing Guide.