Skip to main content

545 docs tagged with "reference"

View all tags

AccessControl

Atlan Type representing parent model for Persona, Purpose

ADF

Base class for ADF assets.

AdfActivity

Base class for ADF Activities. It is a processing or transformation step that performs a specific task within a pipeline to manipulate or move data

AdfDataflow

Base class for ADF Dataflows. It is a visually designed data transformation logic.

AdfDataset

Base class for ADF Datasets. It is a named view of data that references or points to the data you want to use in activities.

AdfLinkedservice

Base class for ADF Linkedservices. It is a connection to a data source or compute resource used by Azure Data Factory.

AdfPipeline

Base class for ADF Pipelines. It is a logical grouping of activities that together perform a specific data processing task.

ADLS

Base class for Azure Data Lake Storage (ADLS) assets.

ADLSAccount

Instance of an Azure Data Lake Storage (ADLS) account in Atlan.

ADLSContainer

Instance of an Azure Data Lake Storage (ADLS) container in Atlan.

ADLSObject

Instance of an Azure Data Lake Storage (ADLS) blob / object in Atlan.

Admin export

Reference for configuring the Admin export app to export users, groups, personas, purposes, and policies from Atlan into an Excel workbook.

Adoption export

Complete configuration reference for the Adoption export app properties and settings, including views, changes, searches, and delivery options.

AI

Base class for AI assets.

AI Policy

Complete configuration reference for AI policy properties and settings in personas.

AIModel

Instance of an AI model in Atlan.

Airflow

Base class for Airflow assets.

Alation migration assistant

Complete configuration reference for the Alation migration assistant app, including cloud storage setup, image mapping, and CSV schemas for articles, glossaries, terms, and RDBMS assets.

Alert propagation

Complete configuration reference for the alert propagation app properties and settings, including scope, matching options, and propagation behavior.

Analyze feature adoption

Use Lakehouse to analyze which Atlan features users are adopting and how deeply they engage with each feature area.

Anaplan

Base class for all Anaplan types.

Anomalo

Base class for Anomalo assets.

API

Base class for API assets.

APIPath

Instance of an API path that could contain one or more endpoints in Atlan.

APISpec

Instance of an API specification in Atlan.

App

Base class for all App types.

Assess engagement depth

Use Lakehouse to measure how deeply users engage with Atlan through pageview rates, session depth, duration, and user tier analysis.

Asset

Base class for all assets.

Asset - term link

Configuration reference for the Asset-term link app, which automatically links glossary terms to matching assets based on names and filters.

Asset description reverse sync

Configuration reference for the Asset Description Reverse Sync package, including workflow options, filters, audit trail behavior, and offline execution artifacts for Snowflake.

Asset export (advanced)

Complete configuration reference for the Asset export (advanced) app, including output destinations, filter logic, and export attribute selection.

Asset export (basic) for data products

Complete configuration reference for the Asset export (basic) app for data domains, subdomains, and data products, including scope, delivery, and CSV file details.

Asset export (basic) for glossaries

Complete configuration reference for the Asset export (basic) app for glossaries, categories, and terms, including scope, delivery, and CSV file details.

Asset export and import

Overview of asset export and import in Atlan—find the right option and jump to configuration references or how-tos.

Asset Import

Reference for importing assets into Atlan using a CSV file, including input handling, delta options, and CSV format.

ASSETS table

Reference documentation for the ASSETS table, a unified asset registry that serves as the central lookup for all Gold namespace queries

AtlanApp

Base class for all tenant atlan apps types.

AtlanAppDeployment

Tracks pending or completed deployment requests for an atlan application.

AtlanAppInstalled

Represents the currently installed version of an atlan application for a tenant.

AtlanAppTool

Instance of a tool defined in an Atlan application.

Atlas transformer

Complete reference for AtlasTransformer that converts metadata into Atlas entities using pyatlan library classes.

AtlasGlossaryTerm

Instance of a term in Atlan. Terms define concepts in natural language that can be associated with other assets to provide meaning.

AuthPolicy

Model to store an accesscontrol policy in Atlas

AWS

Base class for AWS assets.

Azure

Base class for Azure assets.

Azure API Management Enricher

Reference guide for the Azure API Management Enricher app to import API specs and paths from Azure API Management into Atlan.

BaseHandler

Complete API reference for BaseHandler - the concrete implementation of HandlerInterface for non-SQL data sources.

BaseSQLHandler

Complete API reference for BaseSQLHandler - the concrete implementation of HandlerInterface for SQL-based data sources.

BI

Base class for business intelligence assets.

BI_ASSET_DETAILS table

Reference documentation for the BI_ASSET_DETAILS table containing BI-specific attributes across PowerBI, Tableau, Looker, and Sigma

BigqueryRoutine

Instance of a bigquery routine in atlan. Can be a stored procedure, udf, or tvf.

BIProcess

Instance of business intelligence lineage in Atlan. These are used to short-circuit lineage from table-like assets directly to dashboard-like assets.

Catalog

Base class for catalog assets. Catalog assets include any asset that can participate in lineage.

CleanupInterceptor

Automatically cleans up temporary artifacts and activity state when workflows complete or fail. Supports multiple cleanup base paths and comprehensive error handling.

Cloud

Base class for cloud assets.

Cognite

Base class for Cognite assets.

Cognos

Base class for Cognos assets.

Collection

Instance of a query collection in Atlan.

Column

Instance of a column in Atlan.

ColumnProcess

Instance of a column-level lineage process in Atlan. Inputs and outputs of these processes should be columns.

Common utilities

Reference documentation for utility functions in the transformers module for text processing, qualified name building, and template path mapping.

Compute and cost tracking

Understand how Data Quality Studio uses compute resources, how costs are calculated, and practical ways to track and optimize spend for Snowflake and Databricks.

Config maps

Complete technical reference for config map schema and implementation in the Atlan Apps Framework

Configure risk metadata

Configuration reference for enriching AI Application assets with risk metadata using the AI Application Risk Classifier.

Connection

Instance of a connection to a data source in Atlan.

Credential

Reference for the credential widget: secure input and storage of sensitive authentication data

Cube

Instance of a Cube in Atlan.

Custom

Base class for all Custom types.

Custom Metadata Extender

Complete configuration reference for the Custom Metadata Extender app to broaden the scope of custom metadata across new connections and glossaries.

Custom metadata properties

Complete reference for custom metadata property configuration, including all field types, settings, and asset targeting options.

Data reference

Overview of namespaces, schemas, and tables available in the Lakehouse

DATA_MESH_DETAILS table

Reference documentation for the DATA_MESH_DETAILS table containing data domain and data product metadata

Database

Instance of a (relational) database in Atlan.

DatabricksExternalLocationPath

Represents a path within a Databricks External Location, providing access to specific data files or directories in external storage.

DatabricksVolume

Represents a Databricks Volume, a storage object for managing and accessing data files within Databricks workspaces.

DatabricksVolumePath

Represents a path within a Databricks Volume, providing access to specific data files or directories.

DataMesh

Base class for data mesh assets.

DataMeshDataset

Instance of a dataset in Atlan. A dataset acts as a logical bridge between Data Products and physical Data Assets (Tables/Files), enabling better organization, governance, and discovery.

DataStudio

Base class for Google Data Studio assets.

Dbt

Base class for dbt assets.

DbtEntity

Instance of a dbt semantic entity in Atlan.

DbtMeasure

Instance of a dbt semantic measure in Atlan.

DbtModel

Instance of a dbt model in Atlan.

DbtProcess

Instance of a lineage process for dbt in Atlan.

DbtSeed

Instance of a dbt seed in Atlan.

DbtSource

Instance of a dbt source asset in Atlan.

DbtTag

Instance of a dbt tag in Atlan.

DbtTest

Instance of a dbt test in Atlan.

Domo

Base class for Domo assets.

DomoCard

Instance of a Domo Card in Atlan.

Dremio

Base class for Dremio assets.

DremioFolder

Instance of a Dremio Folder in Atlan. Represents organizational containers within spaces or sources that can contain datasets and sub-folders, enabling hierarchical data organization.

DremioPhysicalDataset

Instance of a Dremio Physical Dataset (Table) in Atlan. Represents actual data files or database tables that can be queried directly and serve as the foundation for virtual datasets.

DremioSource

Instance of a Dremio Source in Atlan. Represents external data connections that provide access to data stored in various systems like cloud storage, databases, or file systems.

DremioSpace

Instance of a Dremio Space in Atlan. Represents a logical workspace in Dremio where users can create and organize virtual datasets.

DremioVirtualDataset

Instance of a Dremio Virtual Dataset (View) in Atlan. Represents SQL-defined views that transform and combine data from physical datasets or other virtual datasets.

DynamoDB

Base class for DynamoDB assets in Atlan.

Enrichment Migrator

Complete configuration reference for the Enrichment Migrator app properties and settings.

ENTITY_HISTORY namespace

Reference documentation for the ENTITY_HISTORY namespace containing historical snapshots of asset metadata

ENTITY_METADATA namespace

Reference documentation for the ENTITY_METADATA namespace containing raw metadata tables for all Atlan assets

EventInterceptor

Tracks workflow and activity execution events for monitoring and observability. Automatically publishes events when workflows and activities start and end.

Fabric

Base class for all Fabric types.

FabricPage

Instance of a Microsoft Fabric page in Atlan.

File

Instance of a static file in Atlan.

Flow

Base class for flow-specific (ETL, other data processing) assets.

FlowDataset

An ephemeral piece of data either produced by or used as input by a data operation.

FlowDatasetOperation

A nested data operation that uses at least one ephemeral dataset as either an input or output.

FlowField

A single field of data within a broader ephemeral dataset.

FlowFieldOperation

A nested field-level operation that uses at least one ephemeral field as either an input or output.

FlowFolder

A grouping mechanism within a project to further organize data processing.

FlowProject

A project, workspace or namespace that is used to organize data processing.

FlowReusableUnit

A reusable grouping of data flows that will be orchestrated together as a single unit.

Folder

Instance of a folder within a query collection in Atlan.

Form

Instance of a form in Atlan.

Function

Instance of a function in Atlan.

GCS

Base class for Google Cloud Storage (GCS) assets.

GCSBucket

Instance of a Google Cloud Storage bucket in Atlan.

GCSObject

Instance of a Google Cloud Storage object in Atlan.

GLOSSARY_DETAILS table

Reference documentation for the GLOSSARY_DETAILS table containing glossary, category, and term details

GOLD namespace

Reference documentation for the GOLD namespace containing curated tables for human users and AI tools

Google

Base class for Google assets.

HandlerInterface

Complete API reference for HandlerInterface - the abstract base class defining the contract that all handlers must fulfill.

Iceberg

Base class for Iceberg assets.

IcebergInput

Reads data from Apache Iceberg tables using daft. Provides support for reading Iceberg table data as DataFrames with lazy evaluation.

IcebergNamespace

Instance of an Iceberg namespace in Atlan. Supports nested namespaces with dot-separated paths.

IcebergOutput

Writes data to Apache Iceberg tables using daft. Supports table creation, schema inference, and multiple write modes.

Input

Reference for the input widget: text input field for capturing user data

Inputs

Complete reference for input classes that read data from various sources including SQL queries, Parquet files, JSON files, and Iceberg tables.

Insight

Base class for Insights assets in Atlan.

Interceptors

Complete reference for Temporal interceptors that provide cross-cutting concerns including event tracking, distributed locking, and automatic cleanup.

JsonInput

Reads data from JSON files, supporting both single files and directories containing multiple JSON files. Supports JSONL (JSON Lines) format where each line is a separate JSON object.

JsonOutput

Writes data to JSON files (JSONL format) with support for chunking, buffering, null field processing, and automatic object store uploads.

Kafka

Base class for Kafka assets.

KafkaConsumerGroup

Instance of a Kafka ConsumerGroup in Atlan. These group consumers of topics in Kafka.

KafkaField

Instance of a field within a Kafka topic schema in Atlan, enabling field-level lineage.

Lineage analysis

Use Lakehouse to run advanced lineage analysis across systems and connectors.

Lineage and asset loader

Complete configuration reference for the Lineage and asset loader app, including S3 authentication methods, CSV file schema, asset creation controls, and workflow settings.

Lineage Builder

Complete configuration reference for the Lineage Builder app properties and settings, including CSV file format and asset handling options.

Lineage full export

Export complete lineage information from your metadata lakehouse for reuse across impact, dashboard, and root cause analysis.

Link

Instance of a link in Atlan.

Looker

Base class for Looker assets.

LookerExplore

Instance of a Looker Explore in Atlan. Explores are views that users can query in Looker.

LookerFolder

Instance of a Looker folder in Atlan. Folders in Looker are used to organize content in a hierarchical structure and granting access.

LookerLook

Instance of a Looker Look in Atlan. Looks are saved visualizations used to understand and analyze data. They can be shared and reused in multiple dashboards.

LookerModel

Instance of a Looker model in Atlan. Models combine Explores and dashboards.

LookerProject

Instance of a Looker project in Atlan. Projects are a collection of files that describe the objects, connections and user interface elements in Looker.

LookerView

Instance of a Looker view in Atlan. Views represent tables of data in Looker, whether the table is database-native or created using Looker's derived table functionality.

MatillionComponent

Instance of a Matillion component in Atlan. Components in Matillion are a part of a job, where each component is responsible for accomplishing a task based on the type of component used.

MatillionGroup

Instance of a Matillion group in Atlan. A group in Matillion is the top-level hierarchy, where resources are managed and explored.

MatillionJob

Instance of a Matillion job in Atlan. Jobs in Matillion design, organize and execute workflows which are responsible for ETL data processing.

MatillionProject

Instance of a Matillion project in Atlan. A project in Matillion is a logical grouping of configuration settings and jobs which are responsible for data processing and transformation.

MCIncident

Instance of a Monte Carlo incident in Atlan.

MCMonitor

Instance of a Monte Carlo monitor in Atlan.

Measure retention

Use Lakehouse to measure user activation, churn, reactivation, and cohort retention for a customer domain.

Metadata Completeness

Complete configuration reference for the Metadata Completeness workflow properties and settings.

Metadata export

Use Lakehouse to export rich metadata for AI applications, data marketplaces, and syncing context back to source systems.

Metadata extraction workflows

Complete reference for workflows that orchestrate metadata extraction from SQL databases, including databases, schemas, tables, columns, and procedures.

Metadata Policy

Complete configuration reference for metadata policy properties and settings in personas.

Metadata Policy Helper

Complete configuration reference for the Metadata Policy Helper app, including all supported policy patterns, permissions, and field definitions.

Metadata Propagator

Complete configuration reference for the Metadata Propagator app, including propagation direction, attribute selection, filters, and matching behavior.

Metadata types

Reference for Atlan's metadata type system—the schema definitions for every asset, relationship, and metadata object in Atlan.

Metric

Base class for data quality metrics assets.

Metrics and glossary alignment

Use Lakehouse to identify and consolidate duplicate metrics and glossary terms to keep reporting consistent and maintain a single source of truth

Mode

Base class for Mode assets.

Model

Assets used to model data and information.

ModelAttribute

Instance of an attribute within a data model entity in Atlan.

ModelEntity

Instance of an entity within a version of a data model in Atlan.

MongoDB

Base class for MongoDB assets.

Namespace

Base class for query collections and folders.

NoSQL

Base class for NoSQL assets.

Notebook

Base class for all notebook assets.

OBSERVABILITY namespace

Reference documentation for the OBSERVABILITY namespace containing job execution metrics and data quality scores in the Atlan Lakehouse

Operations

Atlan crawls and manages the following data quality operations and results from Snowflake.

Orchestration tasks attribute transfer

Complete configuration reference for the Orchestration tasks attribute transfer app, including connector selection, custom metadata mapping, transfer direction, and filter options.

Outputs

Complete reference for output classes that write data to various destinations including Parquet files, JSON files, and Iceberg tables.

Overview

Explore practical Lakehouse use cases across metadata quality, lineage, cost optimization, and glossary analysis.

ParquetInput

Reads data from Parquet files, supporting both single files and directories containing multiple Parquet files. Automatically handles local and object store paths.

ParquetOutput

Writes data to Parquet files with support for chunking, consolidation, Hive partitioning, and automatic object store uploads.

Partial

Base class representing assets that cannot be resolved to a pre-existing asset.

PartialField

Field-level assets that could not be resolved to a pre-existing asset.

PartialObject

Object-level assets that could not be resolved to a pre-existing asset.

Password

Reference for the password widget: secure input field for sensitive data

PBI OLS Dataset Enricher

Complete configuration reference for the PBI OLS Dataset Enricher app, including S3 authentication, connection setup, and how it restores Power BI lineage broken by OLS.

Persona

Atlan Type representing a Persona model

PIPELINE_DETAILS table

Reference documentation for the PIPELINE_DETAILS table containing data pipeline and orchestration assets

PowerBI

Base class for Power BI assets.

PowerBIDashboard

Instance of a Power BI dashboard in Atlan. Dashboards are a single page, often called a canvas, that tell a story through visualization.

PowerBIDataflow

Instance of a Power BI dataflow in Atlan. Dataflows are reusable transformation logic that can be shared by many datasets and reports inside Power BI.

PowerBIDataflowEntityColumn

Instance of a Power BI Dataflow Entity Column in Atlan. Dataflows are reusable transformation logic that can be shared by many datasets and reports inside Power BI. Each Dataflow has an Entity which represents an instance of SQL data from source, that has columns associated with it.

PowerBIMeasure

Instance of a Power BI measure in Atlan. Measures define calculations in a DAX model, which helps calculate values based on each row.

PowerBIPage

Instance of a Power BI page in Atlan. Pages organize and subdivide a report in Power BI.

PowerBITile

Instance of a Power BI tile in Atlan. Tiles are snapshots of data, pinned to a dashboard.

PowerBIWorkspace

Instance of a Power BI workspace in Atlan. Workspaces contain dashboards, reports, workbooks, datasets and dataflows.

Preset

Base class for Preset assets.

Priority Propagator

Complete configuration reference for the Priority Propagator app to propagate tags or custom metadata from child assets to parent assets based on configurable priority rules.

Procedure

Instance of a stored procedure (routine) in Atlan.

Process

Instance of a lineage process in Atlan.

Purpose

Atlan Type representing a Purpose model

Qlik

Base class for Qlik assets.

QlikApp

Instance of a Qlik app in Atlan.

QlikDataset

Instance of a Qlik dataset, datafile, datastore or dataasset in Atlan.

Query

Instance of a query in Atlan.

Query extraction workflows

Complete reference for workflows that orchestrate SQL query extraction from database query logs and history.

Query-based transformer

Complete reference for QueryBasedTransformer that transforms metadata using SQL queries defined in YAML templates.

QuickSightAnalysis

Instance of a QuickSight analysis in Atlan. In QuickSight, you analyze and visualize your data in analyses, which can be published as a dashboard to share with others.

QuickSightAnalysisVisual

Instance of a QuickSight analysis visual in Atlan. These represent individual visuals inside an analysis.

QuickSightDashboard

Instance of a QuickSight dashboard in Atlan. These are reports in QuickSight, created from analyses.

QuickSightDashboardVisual

Instance of a QuickSight dashboard visual in Atlan. These represent individual visuals inside a dashboard.

QuickSightDataset

Instance of a QuickSight dataset in Atlan. These are an internal data model built to be used by analysis. In a dataset, data can be pulled from different sources, joined, filtered, and columns translated to more business-friendly names when preparing the data for visualizing in the analysis layer.

Radio

Reference for the radio widget: single selection from visible options

Readme

Instance of a README in Atlan.

Redash

Base class for Redash assets.

RedashDashboard

Instance of a Redash dashboard in Atlan. These are collections of widgets.

RedisLockInterceptor

Manages distributed locks for activities using Redis. Limits concurrent execution to a specified number of activities with the same lock name.

Referenceable

Base class for everything in Atlan that can be referenced by qualifiedName.

RELATIONAL_ASSET_DETAILS table

Reference documentation for the RELATIONAL_ASSET_DETAILS table containing all relational database and data warehouse assets

Rules and dimensions

Reference for available data quality rules and classification dimensions in Snowflake data quality.

S3

Base class for S3 assets.

S3Bucket

Instance of an S3 bucket in Atlan.

S3Object

Instance of an S3 object in Atlan.

S3Prefix

Instance of an S3 prefix in Atlan.

SaaS

Base class for SaaS application assets.

SageMaker

Base class for AWS SageMaker assets.

SageMakerFeature

Instance of a SageMaker Feature in Atlan. Represents an individual feature within a Feature Group, including its data type and metadata.

SageMakerFeatureGroup

Instance of a SageMaker Feature Store Feature Group in Atlan. Represents a collection of related features that can be used for machine learning training and inference.

SageMakerModel

Instance of a SageMaker ML Model in Atlan. Represents trained machine learning models that can be deployed for inference.

SageMakerModelDeployment

Instance of a SageMaker Endpoint in Atlan. Represents deployed models that can serve real-time inference requests.

SageMakerModelGroup

Instance of a SageMaker Model Package Group in Atlan. Represents a collection of versioned models that can be organized and managed together.

SageMakerUnifiedStudioAsset

Instance of SageMaker Unified Studio asset in Atlan. This holds common attributes for both Published and Subscribed assets.

SageMakerUnifiedStudioSubscribedAsset

Instance of SageMaker Unified Studio subscribed asset in Atlan. A subscribed asset is analogous to a view, with its own lifecycle independent from the published asset itself.

SAP

Base class for SAP assets.

Schema

Instance of a database schema in Atlan.

Semantic

Base class for semantic layer assets.

SemanticEntity

Base class for semantic entities/logical tables across different sources.

SemanticField

Base class for semantic fields (measures, dimensions, entities) across different sources.

SemanticModel

Base class for semantic models across different sources.

Set up lineage tables

Create the LINEAGE table in your warehouse for multi-hop lineage queries on Lakehouse data.

Sigma

Base class for Sigma assets.

Sisense

Base class for Sisense assets.

SisenseDashboard

Instance of a Sisense dashboard in Atlan. These allow you to place multiple widgets on a single page.

SisenseDatamodel

Instance of a Sisense datamodel in Atlan. These group tables together that you can use to build dashboards.

Snowflake

Base class for Snowflake-specific assets.

Soda

Base class for Soda assets.

Source asset type

Detailed parsing rules and configuration details for all supported source asset types in the Lineage Generator (no transformations) app.

SourceTag

Instance of a source system-imported tag in Atlan.

Spark

Base class for Spark assets

SparkJob

Instance of a Spark Job run in Atlan.

SQL

Base class for SQL assets.

SqlInsight

Base class for SQL insight assets derived from query traffic analysis.

SqlInsightJoin

A directed join pattern observed between two SQL datasets from real query traffic.

SQLQueryInput

Reads data from SQL databases by executing SQL queries. Supports both SQLAlchemy engines and connection strings, with automatic handling of async and sync operations.

SQLTree

Reference for the SQLTree widget: hierarchical selection from SQL query results

StarburstDataset

Instance of a Starburst dataset in Atlan. A dataset is a view or materialized view published through a Starburst Data Product.

StateStore

Complete technical reference for StateStore service, methods, and usage patterns in the Atlan Apps Framework

Superset

Base class for all Superset types.

Table

Instance of a database table in Atlan.

Tableau

Base class for Tableau assets.

TableauCalculatedField

Instance of a Tableau calculated field in Atlan. These are created by combining two or more fields using a formula, and can be created at datasource or worksheet level.

TableauDashboard

Instance of a Tableau dashboard in Atlan. These are collections of several views, letting you compare a variety of data simultaneously.

TableauDatasource

Instance of a Tableau datasource in Atlan. These include both published and embedded datasources, and are the link between source data and Tableau.

TableauProject

Instance of a Tableau project in Atlan. These are used to organize other assets and for access control, and can be nested.

TableauWorkbook

Instance of a Tableau workbook in Atlan. These contain one or more worksheets, datasources or dashboards.

Tag

Base class for all (source-specific) tag assets.

Task

Instance of a Task for user in Atlan.

Track active users

Use Lakehouse to measure daily, weekly, and monthly active users from the usage_analytics namespace.

Transformers

Overview of metadata transformers that convert raw metadata into Atlas-compatible entities for ingestion into Atlan.

UI widgets

Create intuitive user interfaces for your Atlan applications using the framework's UI components and design system

Usage patterns

Common implementation patterns for using output classes to write data to various destinations.

Use conversational AI

Learn how to use conversational AI in Atlan to explore data, understand lineage, and work with business concepts using natural-language prompts.

User Role Import

Complete configuration reference for the User Role Import app properties and settings.

User Role Sync

Complete configuration reference for the User Role Sync app properties and settings.

View

Instance of a database view in Atlan.

Widget props

Reference for shared properties available across all UI widgets in the Atlan Apps Framework

Workflow

Instance of a governance workflow.

Workflows

Overview of Temporal workflows that orchestrate long-running processes for metadata extraction and query mining in Atlan applications.