Skip to content

Sigma

Base class for Sigma 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 Sigma 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 Sigma {
        <<abstract>>
    }
    link Sigma "../sigma"
    class BI {
        <<abstract>>
    }
    link BI "../entities/bi"
    BI <|-- Sigma : 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 SigmaDatasetColumn
    link SigmaDatasetColumn "../entities/sigmadatasetcolumn"
    Sigma <|-- SigmaDatasetColumn : extends
    class SigmaDataset
    link SigmaDataset "../entities/sigmadataset"
    Sigma <|-- SigmaDataset : extends
    class SigmaWorkbook
    link SigmaWorkbook "../entities/sigmaworkbook"
    Sigma <|-- SigmaWorkbook : extends
    class SigmaDataElementField
    link SigmaDataElementField "../entities/sigmadataelementfield"
    Sigma <|-- SigmaDataElementField : extends
    class SigmaPage
    link SigmaPage "../entities/sigmapage"
    Sigma <|-- SigmaPage : extends
    class SigmaDataElement
    link SigmaDataElement "../entities/sigmadataelement"
    Sigma <|-- SigmaDataElement : extends

Type-specific properties

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

sigmaDataElementName
TBC
1
2
3
4
builder.sigmaDataElementName("String0"); // (1)
sigma.getSigmaDataElementName(); // (2)
client.assets.select().where(Sigma.SIGMA_DATA_ELEMENT_NAME.eq("String0")); // (3)
client.assets.select().where(Sigma.SIGMA_DATA_ELEMENT_NAME.match("String0")); // (4)

  1. Set the sigmaDataElementName for a Sigma.

    For more details

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

  2. Retrieve the sigmaDataElementName from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigmaDataElementName 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 sigmaDataElementName textually matching the provided value.

    For more details

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

sigmaDataElementQualifiedName
TBC
1
2
3
4
builder.sigmaDataElementQualifiedName("String0"); // (1)
sigma.getSigmaDataElementQualifiedName(); // (2)
client.assets.select().where(Sigma.SIGMA_DATA_ELEMENT_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Sigma.SIGMA_DATA_ELEMENT_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the sigmaDataElementQualifiedName for a Sigma.

    For more details

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

  2. Retrieve the sigmaDataElementQualifiedName from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigmaDataElementQualifiedName 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 sigmaDataElementQualifiedName textually matching the provided value.

    For more details

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

sigmaPageName
TBC
1
2
3
4
builder.sigmaPageName("String0"); // (1)
sigma.getSigmaPageName(); // (2)
client.assets.select().where(Sigma.SIGMA_PAGE_NAME.eq("String0")); // (3)
client.assets.select().where(Sigma.SIGMA_PAGE_NAME.match("String0")); // (4)

  1. Set the sigmaPageName for a Sigma.

    For more details

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

  2. Retrieve the sigmaPageName from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigmaPageName 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 sigmaPageName textually matching the provided value.

    For more details

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

sigmaPageQualifiedName
TBC
1
2
3
4
builder.sigmaPageQualifiedName("String0"); // (1)
sigma.getSigmaPageQualifiedName(); // (2)
client.assets.select().where(Sigma.SIGMA_PAGE_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Sigma.SIGMA_PAGE_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the sigmaPageQualifiedName for a Sigma.

    For more details

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

  2. Retrieve the sigmaPageQualifiedName from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigmaPageQualifiedName 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 sigmaPageQualifiedName textually matching the provided value.

    For more details

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

sigmaWorkbookName
TBC
1
2
3
4
builder.sigmaWorkbookName("String0"); // (1)
sigma.getSigmaWorkbookName(); // (2)
client.assets.select().where(Sigma.SIGMA_WORKBOOK_NAME.eq("String0")); // (3)
client.assets.select().where(Sigma.SIGMA_WORKBOOK_NAME.match("String0")); // (4)

  1. Set the sigmaWorkbookName for a Sigma.

    For more details

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

  2. Retrieve the sigmaWorkbookName from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigmaWorkbookName 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 sigmaWorkbookName textually matching the provided value.

    For more details

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

sigmaWorkbookQualifiedName
TBC
1
2
3
4
builder.sigmaWorkbookQualifiedName("String0"); // (1)
sigma.getSigmaWorkbookQualifiedName(); // (2)
client.assets.select().where(Sigma.SIGMA_WORKBOOK_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Sigma.SIGMA_WORKBOOK_QUALIFIED_NAME.match("String0")); // (4)

  1. Set the sigmaWorkbookQualifiedName for a Sigma.

    For more details

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

  2. Retrieve the sigmaWorkbookQualifiedName from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigmaWorkbookQualifiedName 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 sigmaWorkbookQualifiedName textually matching the provided value.

    For more details

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

sigma_data_element_name
TBC
1
2
3
4
builder.sigma_data_element_name = ...  # (1)
sigma.sigma_data_element_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_DATA_ELEMENT_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_DATA_ELEMENT_NAME.match("String0"))  # (4)

  1. Set the sigma_data_element_name for a Sigma.

    For more details

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

  2. Retrieve the sigma_data_element_name from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigma_data_element_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 sigma_data_element_name textually matching the provided value.

    For more details

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

sigma_data_element_qualified_name
TBC
1
2
3
4
builder.sigma_data_element_qualified_name = ...  # (1)
sigma.sigma_data_element_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_DATA_ELEMENT_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_DATA_ELEMENT_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the sigma_data_element_qualified_name for a Sigma.

    For more details

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

  2. Retrieve the sigma_data_element_qualified_name from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigma_data_element_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 sigma_data_element_qualified_name textually matching the provided value.

    For more details

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

sigma_page_name
TBC
1
2
3
4
builder.sigma_page_name = ...  # (1)
sigma.sigma_page_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_PAGE_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_PAGE_NAME.match("String0"))  # (4)

  1. Set the sigma_page_name for a Sigma.

    For more details

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

  2. Retrieve the sigma_page_name from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigma_page_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 sigma_page_name textually matching the provided value.

    For more details

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

sigma_page_qualified_name
TBC
1
2
3
4
builder.sigma_page_qualified_name = ...  # (1)
sigma.sigma_page_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_PAGE_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_PAGE_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the sigma_page_qualified_name for a Sigma.

    For more details

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

  2. Retrieve the sigma_page_qualified_name from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigma_page_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 sigma_page_qualified_name textually matching the provided value.

    For more details

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

sigma_workbook_name
TBC
1
2
3
4
builder.sigma_workbook_name = ...  # (1)
sigma.sigma_workbook_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_WORKBOOK_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_WORKBOOK_NAME.match("String0"))  # (4)

  1. Set the sigma_workbook_name for a Sigma.

    For more details

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

  2. Retrieve the sigma_workbook_name from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigma_workbook_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 sigma_workbook_name textually matching the provided value.

    For more details

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

sigma_workbook_qualified_name
TBC
1
2
3
4
builder.sigma_workbook_qualified_name = ...  # (1)
sigma.sigma_workbook_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_WORKBOOK_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Sigma)).where(Sigma.SIGMA_WORKBOOK_QUALIFIED_NAME.match("String0"))  # (4)

  1. Set the sigma_workbook_qualified_name for a Sigma.

    For more details

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

  2. Retrieve the sigma_workbook_qualified_name from a Sigma.

    For more details

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

  3. Find all assets in Atlan with their sigma_workbook_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 sigma_workbook_qualified_name textually matching the provided value.

    For more details

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

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

  1. Set the sigmaDataElementName for a Sigma.

    For more details

    For more information, see the asset CRUD snippets.

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

  1. Set the sigmaDataElementQualifiedName for a Sigma.

    For more details

    For more information, see the asset CRUD snippets.

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

  1. Set the sigmaPageName for a Sigma.

    For more details

    For more information, see the asset CRUD snippets.

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

  1. Set the sigmaPageQualifiedName for a Sigma.

    For more details

    For more information, see the asset CRUD snippets.

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

  1. Set the sigmaWorkbookName for a Sigma.

    For more details

    For more information, see the asset CRUD snippets.

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

  1. Set the sigmaWorkbookQualifiedName for a Sigma.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

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

erDiagram
    Connection ||..o{ SigmaWorkbook : ""
    Connection ||..o{ SigmaDataset : ""
    SigmaWorkbook |o--o{ SigmaPage : sigmaPages
    SigmaPage |o--o{ SigmaDataElement : sigmaDataElements
    SigmaDataElement |o--o{ SigmaDataElementField : sigmaDataElementFields
    SigmaDataset |o--o{ SigmaDatasetColumn : sigmaDatasetColumns