Skip to content

Redash

Base class for Redash assets.

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand managing Redash assets in Atlan. For that, we would suggest starting with either:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.
classDiagram
    direction RL
    class Redash {
        <<abstract>>
    }
    link Redash "../redash"
    class BI {
        <<abstract>>
    }
    link BI "../entities/bi"
    BI <|-- Redash : extends
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- BI : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class RedashDashboard
    link RedashDashboard "../entities/redashdashboard"
    Redash <|-- RedashDashboard : extends
    class RedashQuery
    link RedashQuery "../entities/redashquery"
    Redash <|-- RedashQuery : extends
    class RedashVisualization
    link RedashVisualization "../entities/redashvisualization"
    Redash <|-- RedashVisualization : extends

Type-specific properties

Following are the properties uniquely available on Redash assets in Atlan.

redashIsPublished
Whether the asset is published in Redash (true) or not (false).
1
2
3
builder.redashIsPublished(true); // (1)
redash.getRedashIsPublished(); // (2)
client.assets.select().where(Redash.REDASH_IS_PUBLISHED.eq(true)); // (3)

  1. Set the redashIsPublished for a Redash.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the redashIsPublished from a Redash.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their redashIsPublished exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

redash_is_published
Status whether the asset is published or not on source
1
2
3
builder.redash_is_published = ...  # (1)
redash.redash_is_published  # (2)
FluentSearch().where(FluentSearch.asset_type(Redash)).where(Redash.REDASH_IS_PUBLISHED.eq(True))  # (3)

  1. Set the redash_is_published for a Redash.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the redash_is_published from a Redash.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their redash_is_published exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

redashIsPublished
Whether the asset is published in Redash (true) or not (false).
1
2
3
4
5
{
  "attributes": {
    "redashIsPublished": true // (1)
  }
}

  1. Set the redashIsPublished for a Redash.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

The following illustrates how the various Redash objects inter-relate with each other:

erDiagram
    Connection ||..o{ RedashDashboard : ""
    Connection ||..o{ RedashQuery : ""
    RedashQuery |o--o{ RedashVisualization : redashVisualizations