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

Properties

These attributes are specific to instances of Sigma (and all of its subtypes).

sigmaDataElementName

Simple name of the data element in which this asset exists.

sigmaDataElementQualifiedName

Unique name of the data element in which this asset exists.

sigmaPageName

Simple name of the page on which this asset exists.

sigmaPageQualifiedName

Unique name of the page on which this asset exists.

sigmaWorkbookName

Simple name of the workbook in which this asset exists.

sigmaWorkbookQualifiedName

Unique name of the workbook in which this asset exists.

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

---