Skip to main content

65 docs tagged with "reference"

View all tags

Admin export

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

AI Policy

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

Atlas transformer

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

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.

CleanupInterceptor

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

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.

Credential

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

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.

Enrichment Migrator

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

EventInterceptor

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

HandlerInterface

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

IcebergInput

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

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.

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.

Lineage Builder

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

Metadata Completeness

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

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.

Operations

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

Outputs

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

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.

Password

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

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.

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.

Radio

Reference for the radio widget: single selection from visible options

RedisLockInterceptor

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

Rules and dimensions

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

Source asset type

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

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

StateStore

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

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.

Widget props

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

Workflows

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