Skip to content

Metabase

Base class for Metabase 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 Metabase 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 Metabase {
        <<abstract>>
    }
    link Metabase "../metabase"
    class BI {
        <<abstract>>
    }
    link BI "../entities/bi"
    BI <|-- Metabase : 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 MetabaseQuestion
    link MetabaseQuestion "../entities/metabasequestion"
    Metabase <|-- MetabaseQuestion : extends
    class MetabaseCollection
    link MetabaseCollection "../entities/metabasecollection"
    Metabase <|-- MetabaseCollection : extends
    class MetabaseDashboard
    link MetabaseDashboard "../entities/metabasedashboard"
    Metabase <|-- MetabaseDashboard : extends

Type-specific properties

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

metabaseCollectionName
TBC
1
2
3
4
builder.metabaseCollectionName("String0"); // (1)
metabase.getMetabaseCollectionName(); // (2)
client.assets.select().where(Metabase.METABASE_COLLECTION_NAME.eq("String0")); // (3)
client.assets.select().where(Metabase.METABASE_COLLECTION_NAME.match("String0")); // (4)

  1. Set the metabaseCollectionName for a Metabase.

    For more details

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

  2. Retrieve the metabaseCollectionName from a Metabase.

    For more details

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

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

    For more details

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

  4. Find all assets in Atlan with their metabaseCollectionName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

metabaseCollectionQualifiedName
TBC
1
2
3
4
builder.metabaseCollectionQualifiedName("String0"); // (1)
metabase.getMetabaseCollectionQualifiedName(); // (2)
client.assets.select().where(Metabase.METABASE_COLLECTION_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Metabase.METABASE_COLLECTION_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the metabaseCollectionQualifiedName for a Metabase.

    For more details

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

  2. Retrieve the metabaseCollectionQualifiedName from a Metabase.

    For more details

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

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

    For more details

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

  4. Find all assets in Atlan with their metabaseCollectionQualifiedName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

metabase_collection_name
TBC
1
2
3
4
builder.metabase_collection_name = ...  # (1)
metabase.metabase_collection_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Metabase)).where(Metabase.METABASE_COLLECTION_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Metabase)).where(Metabase.METABASE_COLLECTION_NAME.match("String0"))  # (4)

  1. Set the metabase_collection_name for a Metabase.

    For more details

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

  2. Retrieve the metabase_collection_name from a Metabase.

    For more details

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

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

    For more details

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

  4. Find all assets in Atlan with their metabase_collection_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

metabase_collection_qualified_name
TBC
1
2
3
4
builder.metabase_collection_qualified_name = ...  # (1)
metabase.metabase_collection_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Metabase)).where(Metabase.METABASE_COLLECTION_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Metabase)).where(Metabase.METABASE_COLLECTION_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the metabase_collection_qualified_name for a Metabase.

    For more details

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

  2. Retrieve the metabase_collection_qualified_name from a Metabase.

    For more details

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

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

    For more details

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

  4. Find all assets in Atlan with their metabase_collection_qualified_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

metabaseCollectionName
TBC
1
2
3
4
5
{
  "attributes": {
    "metabaseCollectionName": "String0" // (1)
  }
}

  1. Set the metabaseCollectionName for a Metabase.

    For more details

    For more information, see the asset CRUD snippets.

metabaseCollectionQualifiedName
TBC
1
2
3
4
5
{
  "attributes": {
    "metabaseCollectionQualifiedName": "String0" // (1)
  }
}

  1. Set the metabaseCollectionQualifiedName for a Metabase.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

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

erDiagram
    Connection ||..o{ MetabaseCollection : ""
    MetabaseCollection |o--o{ MetabaseDashboard : metabaseDashboards
    MetabaseCollection |o--o{ MetabaseQuestion : metabaseQuestions
    MetabaseDashboard }o--o{ MetabaseQuestion : metabaseQuestions