Redash

Important Capabilities

Capability	Status	Notes
Detect Deleted Entities	✅	Enabled by default via stateful ingestion.
Table-Level Lineage	✅	Enabled by default.

This plugin extracts the following:

• Redash dashboards and queries/visualization
• Redash chart table lineages (disabled by default)

CLI based Ingestion

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

Options

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

Field	Description
api_key string	Redash user API key. Default: REDASH_API_KEY
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

Schema

The JSONSchema for this configuration is inlined below.

{
  "$defs": {
    "AllowDenyPattern": {
      "additionalProperties": false,
      "description": "A class to store allow deny regexes",
      "properties": {
        "allow": {
          "default": [
            ".*"
          ],
          "description": "List of regex patterns to include in ingestion",
          "items": {
            "type": "string"
          },
          "title": "Allow",
          "type": "array"
        },
        "deny": {
          "default": [],
          "description": "List of regex patterns to exclude from ingestion.",
          "items": {
            "type": "string"
          },
          "title": "Deny",
          "type": "array"
        },
        "ignoreCase": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": true,
          "description": "Whether to ignore case sensitivity during pattern matching.",
          "title": "Ignorecase"
        }
      },
      "title": "AllowDenyPattern",
      "type": "object"
    },
    "StatefulIngestionConfig": {
      "additionalProperties": false,
      "description": "Basic Stateful Ingestion Specific Configuration for any source.",
      "properties": {
        "enabled": {
          "default": false,
          "description": "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",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "title": "StatefulIngestionConfig",
      "type": "object"
    }
  },
  "properties": {
    "stateful_ingestion": {
      "anyOf": [
        {
          "$ref": "#/$defs/StatefulIngestionConfig"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Stateful Ingestion Config"
    },
    "connect_uri": {
      "default": "http://localhost:5000",
      "description": "Redash base URL.",
      "title": "Connect Uri",
      "type": "string"
    },
    "api_key": {
      "default": "REDASH_API_KEY",
      "description": "Redash user API key.",
      "title": "Api Key",
      "type": "string"
    },
    "dashboard_patterns": {
      "$ref": "#/$defs/AllowDenyPattern",
      "default": {
        "allow": [
          ".*"
        ],
        "deny": [],
        "ignoreCase": true
      },
      "description": "regex patterns for dashboards to filter for ingestion."
    },
    "chart_patterns": {
      "$ref": "#/$defs/AllowDenyPattern",
      "default": {
        "allow": [
          ".*"
        ],
        "deny": [],
        "ignoreCase": true
      },
      "description": "regex patterns for charts to filter for ingestion."
    },
    "skip_draft": {
      "default": true,
      "description": "Only ingest published dashboards and charts.",
      "title": "Skip Draft",
      "type": "boolean"
    },
    "page_size": {
      "default": 25,
      "description": "Limit on number of items to be queried at once.",
      "title": "Page Size",
      "type": "integer"
    },
    "api_page_limit": {
      "default": 9223372036854775807,
      "description": "Limit on number of pages queried for ingesting dashboards and charts API during pagination.",
      "title": "Api Page Limit",
      "type": "integer"
    },
    "parallelism": {
      "default": 1,
      "description": "Parallelism to use while processing.",
      "title": "Parallelism",
      "type": "integer"
    },
    "parse_table_names_from_sql": {
      "default": false,
      "description": "See note below.",
      "title": "Parse Table Names From Sql",
      "type": "boolean"
    },
    "env": {
      "default": "PROD",
      "description": "Environment to use in namespace when constructing URNs.",
      "title": "Env",
      "type": "string"
    }
  },
  "title": "RedashConfig",
  "type": "object"
}

Note! 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.

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.