# OpenMetadata Documentation: v2.0.x ## v2.0.x - [v2.0.x / Deployment (110 pages)](https://docs.open-metadata.org/_llms/v2-0-x/deployment.txt): Deployment. - [v2.0.x / Connectors (369 pages)](https://docs.open-metadata.org/_llms/v2-0-x/connectors.txt): Connectors, Connector, Ingestion. - [v2.0.x / SDK & APIs (299 pages)](https://docs.open-metadata.org/_llms/v2-0-x/sdk-and-apis.txt): API Reference, Data Assets, AI Assets, AI SDK, SDK, Discovery, Lineage, Data Contracts, Teams And Users, Data Governance, Data Quality, Alerts, Incidents, Main Concepts. ### Home - [OpenMetadata Documentation](https://docs.open-metadata.org/v2.0.x/index.md): Unified platform for data discovery, lineage, and governance ### Quickstart #### Quickstart - [Quickstart | OpenMetadata Quickstart Guide](https://docs.open-metadata.org/v2.0.x/quick-start.md): Get started with your platform using step-by-step onboarding instructions for setup, integration, and key feature exploration. - [Try OpenMetadata in Docker](https://docs.open-metadata.org/v2.0.x/quick-start/local-docker-deployment.md): Get OpenMetadata running locally in minutes with Docker. Step-by-step setup guide, configuration tips, and troubleshooting for your metadata platform. - [Try OpenMetadata in Kubernetes](https://docs.open-metadata.org/v2.0.x/quick-start/local-kubernetes-deployment.md): Deploy OpenMetadata locally on Kubernetes in minutes. Step-by-step guide with commands, configurations, and troubleshooting for your metadata platform. - [Sandbox Quickstart | OpenMetadata Sandbox Environment](https://docs.open-metadata.org/v2.0.x/quick-start/sandbox.md): Get started with OpenMetadata in minutes using our interactive sandbox environment. Explore data discovery, lineage, and governance features hands-on. ##### Getting Started - [Getting Started with OpenMetadata for Data cataloging](https://docs.open-metadata.org/v2.0.x/quick-start/getting-started.md): Follow this guide to get started quickly with core deployment, authentication, data access, and configuration for your platform setup. ###### Day 1 - [Day 1 Getting Started | OpenMetadata Day 1 Guide](https://docs.open-metadata.org/v2.0.x/quick-start/getting-started/day-1.md): Connect your first data sources, run ingestion, and invite users to start collaborating in OpenMetadata. - [Database service setup](https://docs.open-metadata.org/v2.0.x/quick-start/getting-started/day-1/database-service-setup.md): Configure a database service connection in OpenMetadata and prepare it for metadata ingestion. ### How-to Guides #### How-to Guides - [How-to Guides | Official Documentation to User Guides](https://docs.open-metadata.org/v2.0.x/how-to-guides.md): Step-by-step guidance for how to guides using OpenMetadata. Learn key actions, features, and best practices. ### MCP #### MCP - [MCP Server](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp.md): Overview of the MCP Server built into OpenMetadata, which lets AI clients query metadata in natural language, with OAuth 2.0, PAT, and bot token authentication. - [OAuth 2.0 Authentication for MCP Server](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/oauth.md): Connect to OpenMetadata's MCP Server using OAuth 2.0 with your existing SSO provider. No Personal Access Tokens required. - [MCP Tools Reference](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/reference.md): Reference for all OpenMetadata MCP tools, with parameters and examples for search, entity details, context, lineage, create and patch, and data quality. - [Connecting Agent Frameworks](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/agent-frameworks.md): Connect a programmatic agent framework (CrewAI, LangChain, the OpenAI Agents SDK) to OpenMetadata's MCP server using a Bot token, for unattended, headless integrations. - [Semantic Search MCP Tool](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/semantic-search.md): Use the Semantic Search MCP tool to perform natural language queries against your OpenMetadata catalog through AI assistants. ##### MCP Server Connection - [OpenMetadata MCP Server Connection Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/connect.md): Connect an MCP client to the OpenMetadata MCP Server over Streamable HTTP, authenticate with OAuth 2.0 or a JWT bearer token, and list tools and prompts. - [MCP Server - API Usage & Reference](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/connect-api.md): Call the OpenMetadata MCP Server over JSON-RPC at the /mcp endpoint to run tools and get prompts, with sample requests, error handling, and best practices. ##### Getting Started with MCP Clients - [Getting Started with Claude Desktop](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/claude.md): Set up MCP Server to connect Claude Desktop with OAuth or PAT-based authentication for AI-powered access to your data. - [Getting Started with Claude Code](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/claude-code.md): Connect your OpenMetadata MCP Server to Claude Code (CLI) for AI-powered metadata exploration from the terminal. - [Getting Started with Goose Desktop](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/goose.md): Learn how to connect Goose Desktop with MCP Server, create tokens, and enable secure AI-powered access to your data platform. - [Getting Started with Cursor](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/cursor.md): Connect your OpenMetadata MCP Server to Cursor IDE with OAuth or PAT-based authentication for AI-powered metadata exploration. - [Getting Started with VS Code](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/vscode.md): Connect your OpenMetadata MCP Server to Visual Studio Code for AI-powered metadata exploration. - [Getting Started with Databricks](https://docs.open-metadata.org/v2.0.x/how-to-guides/mcp/databricks.md): Register your OpenMetadata MCP Server as a governed Unity Catalog MCP Service so Databricks agents can discover and call its tools. ### Admin Guide #### Admin Guide - [Admin Guide | OpenMetadata Administration Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide.md): Browse all administrative how-to guides for onboarding, team management, and policy creation. - [How to Ingest Metadata | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/how-to-ingest-metadata.md): Learn how to ingest metadata using connectors for databases, pipelines, dashboards, and storage systems. - [How to Delete a Service Connection | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/delete-service-connection.md): Delete a service connection safely to revoke platform integrations while maintaining metadata integrity and system consistency. - [How To Run Ingestion Pipeline Via CLI with Basic Auth](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/cli-ingestion-with-basic-auth.md): Run an OpenMetadata ingestion pipeline from the CLI with Basic Auth by copying the ingestion-bot JWT token and adding it to the workflow securityConfig. - [Reindexing Search](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/reindexing-search.md): Rebuild the OpenMetadata Elasticsearch or OpenSearch index when search results or asset counts are wrong, and tune batch size, threads, queues, and retries. - [Resolving Data Insights and KPI Display Issues in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/data-insights.md): Fix empty Data Insights and missing KPI charts in OpenMetadata by installing and running the Data Insights application with backfill and index recreation. - [Permission Debugger | Analyze and Troubleshoot User Access](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/permission-debugger.md): Use the Permission Debugger to simulate permission checks, verify policies, and troubleshoot user access issues across roles, teams, and resources. ##### Manage Teams and Users - [Team Structure in OpenMetadata | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/teams-and-users/team-structure-openmetadata.md): Understand team structure setup to align users, roles, and permissions in a way that supports secure and scalable collaboration. - [How to Add a Team | OpenMetadata Admin Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/teams-and-users/add-team.md): Connect Add Team to enable streamlined access, monitoring, or search of enterprise data using secure and scalable integrations. - [How to Invite Users to OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/teams-and-users/invite-users.md): Invite users and configure their team access using email, domain patterns, or integrations with your identity platform. - [How to Add Users to Teams](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/teams-and-users/add-users.md): Add users to teams in OpenMetadata while inviting a new user or from a team's Users tab, noting that only Group teams accept direct user members. - [How to Change the Team Type | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/teams-and-users/change-team-type.md): Learn how to change team types to modify access levels and permissions for improved role-based collaboration and enterprise access control. ##### Advanced Guide for Roles and Policies - [Advanced Guide for Roles and Policies](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/roles-policies.md): Manage roles and policies to control permissions, ownership, and governance enforcement. - [Building Blocks of Authorization - Rules, Policies, and Roles](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/roles-policies/authorization.md): Understand authorization policies to manage read, write, and discover permissions for users and service accounts. - [Resource Scope and Operations Reference](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/roles-policies/resource-scope.md): A quick-reference guide to resource categories and common operations in OpenMetadata. Use this when designing rules and policies. - [Use Cases: Roles and Policies](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/roles-policies/use-cases.md): Review real-world role-based access use cases for securing metadata access across teams, departments, and personas. ##### Preferences - [Preferences](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/preferences/index.md): Overview of the platform-wide settings under Settings > Preferences, including branding, email, search, lineage, and profiler defaults. - [Theme and Branding](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/preferences/theme-and-branding.md): Brand your OpenMetadata instance with a custom logo, monogram, favicon, and color palette to match your organization's identity. - [Email](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/preferences/email.md): Configure the SMTP server OpenMetadata uses to send invite, notification, and alert emails, and verify it with a test message. - [Login Configuration](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/preferences/login-configuration.md): Configure the failed login lockout threshold and JWT session expiry. - [Health Check](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/preferences/health-check.md): Check the live status of the database, search index, migrations, and related platform dependencies. - [Profiler Configuration](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/preferences/profiler-configuration.md): Set the default profiler metrics computed per data type, and control whether sample data is stored and readable platform-wide. - [Search Configuration Settings for Relevance, Ranking, and Field Boosting](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/search-configuration-settings.md): Detailed guide on customizing search relevance and behavior across OpenMetadata, including global rules, term boosting, field weighting, and asset-specific configurations. - [Lineage Preferences](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/preferences/lineage.md): Set the default upstream and downstream depth, lineage layer, and pipeline view mode for lineage graphs. - [Data Asset Rules](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/data-asset-rules.md): Enable or disable the instance-wide validation rules that data assets must satisfy, including built-in domain, data product, and ownership rules. - [Learning Resources](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/learning-resources.md): Add, organize, and manage in-product learning content — videos and Storylane tours — that surface contextually across OpenMetadata. ##### Persona and Landing Page Customization - [Persona and Landing Page Customization in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/persona-landing-page-customization.md): Overview of Persona and Landing Page Customization in OpenMetadata, its benefits for different user roles, and the ViewBasic permission on Document it requires. - [Customizable Landing Page with Pluggable Panels](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/persona-landing-page-customization/customizable-landing-page.md): Customize the OpenMetadata landing page for each persona with pluggable panels, and set its app mode, default landing page, and view mode in App Layout. - [How to Define Personas in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/persona-landing-page-customization/defining-persona.md): Define personas in OpenMetadata, such as data engineer or data steward, from Settings > Personas, and associate users so their experience matches their role. ##### Audit Logs - [Audit Logs | Collate Admin Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/admin-guide/audit-logs.md): Track and monitor user actions, entity updates, and platform activities with comprehensive audit logs for governance and compliance ### Guide for Data Users #### Guide for Data Users - [Guide for Data Users | OpenMetadata User Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users.md): Browse user-focused how-to guides covering tags, glossary, descriptions, and asset tracking. - [Understanding the Basics of OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/basics-openmetadata.md): Learn the basics of using the platform, including navigation, lineage exploration, and collaborative features. - [Overview of Data Assets | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/data-asset-tabs.md): Navigate data asset tabs for schema, lineage, profiling, and usage insights in a unified, user-friendly interface. - [How to Add Description using Markdown](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/description.md): Learn how data descriptions help users understand asset context, structure, and lineage across your catalog. - [How to Assign or Change Data Ownership](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/data-ownership.md): Learn how to establish and manage data ownership in OpenMetadata. Complete guide for data users on assigning owners, tracking responsibility, and governance. - [How to Follow a Data Asset | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/follow-data-asset.md): Follow data assets to stay informed about updates, ownership changes, and activity within your areas of interest. - [How to Add Tags | OpenMetadata User Tagging Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/tags.md): Add metadata tags to datasets, columns, or dashboards for improved classification, search, and governance reporting. - [How to Create a Personal Access Token | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/personal-access-token.md): Create personal access tokens to authenticate API requests to OpenMetadata. - [How to Add Glossary Terms | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/glossary.md): Browse and search glossary terms to understand domain-specific terminology across your organization’s data assets. - [How to Create a Custom Property for a Data Asset](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/custom.md): Customize data asset pages by configuring fields, tabs, and layouts to match your organization’s metadata strategy. - [Data Asset Versioning | OpenMetadata Version Control Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/versions.md): Track asset versions and view historical changes to schema, descriptions, tags, and ownership with full traceability. - [How to Delete a Data Asset | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/delete.md): Delete outdated or test assets from your catalog to maintain clean, relevant metadata and simplify search results. - [OpenMetadata Chrome Extension | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/guide-for-data-users/browser-ext.md): Install the browser extension to explore metadata and documentation directly while navigating your data tools. ### Data Discovery #### Data Discovery - [Data Discovery | OpenMetadata How-To Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery.md): Step-by-step guidance for data discovery using OpenMetadata. Learn key actions, features, and best practices. - [How to Discover Assets of Interest](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/discover.md): Discover datasets using advanced filters, tagging, and popularity metrics to find what matters most to your work. - [Guide to Searching Data Using Hierarchical View](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/hierarchy.md): Learn to navigate and search data with the Hierarchical View in OpenMetadata. Expand layers, explore relationships, and access detailed asset information easily. - [Get a Quick Glance of the Data Assets](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/preview.md): Instantly preview data assets with inline metadata, sample rows, schema details, tags, and quality metrics—without leaving the Explore page. - [Detailed View of the Data Assets](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/details.md): Dive into dataset details including lineage, profiling, ownership, and glossary context for complete understanding. - [Using Advanced Search](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/advanced.md): Use advanced search and filtering to discover data across sources, owners, and business domains with high precision. - [Bulk Upload Data Assets with CSV in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/bulk-upload.md): Save time by importing or updating multiple data assets via CSV. Validate and edit inline before finalizing bulk uploads in OpenMetadata. - [Bulk Import Data Assets via CSV in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/import.md): Learn to bulk import databases, schemas, and tables in OpenMetadata using CSV files. Edit inline, validate changes, and import via UI or API. - [Bulk Export Data Assets via CSV in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/export.md): Learn to bulk export database services, databases, schemas, and tables in OpenMetadata as CSV files using the UI or API. - [Troubleshooting for Import-Export issue](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/troubleshooting.md): Resolve glossary CSV export failures in OpenMetadata by checking proxy settings, enabling WebSockets, and verifying real-time connectivity. - [Managing and Editing Table Constraint in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-discovery/table-constraint.md): Learn how to view, edit, and manage table constraints in OpenMetadata to track relationships, enhance lineage, and support data governance. ### Data Contracts #### Data Contracts - [Data Contracts | OpenMetadata Data Contracts](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-contracts.md): Step-by-step guidance for data contracts using OpenMetadata. Learn key actions, features, and best practices. - [Create Data Contracts | OpenMetadata Data Contracts](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-contracts/create.md): Create, edit, run, and import data contracts for tables and other data assets in the OpenMetadata UI. - [Data Contract Specification | OpenMetadata Data Contracts](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-contracts/spec.md): What an OpenMetadata data contract can define, which data assets support each section, what a contract run checks, and how statuses and data product and schema inheritance work. - [ODCS Import and Export | OpenMetadata Data Contracts](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-contracts/odcs.md): Which Open Data Contract Standard (ODCS) versions and fields OpenMetadata imports, how ODCS quality rules become test cases, and how to preview an ODCS import before applying it. ### Data Collaboration #### Data Collaboration - [Data Collaboration | OpenMetadata Collaboration Features](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration.md): Enable data collaboration through announcements, conversations, tags, and task workflows across teams. - [Understanding Activity Feeds | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration/activity-feeds.md): Monitor all activity feeds to stay informed about changes in ownership, usage, classification, or quality events. - [Conversation Threads | OpenMetadata Collaboration Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration/conversation.md): Participate in conversations directly on data assets to resolve questions, clarify context, or suggest updates. - [Create Tasks | OpenMetadata Collaboration Workflow](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration/tasks.md): Manage data collaboration tasks directly within the platform to assign ownership, review status, and track activity. - [Request for Description | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration/request-description.md): Request missing descriptions for datasets, dashboards, or pipelines to improve documentation and usability. - [How to Request for Tags](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration/request-tags.md): Use tag requests to suggest relevant labels for data assets and improve discoverability through collaborative tagging. - [Overview of Announcements | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration/announcements.md): Post platform-wide announcements to share important data updates, outages, or governance messages with teams. - [How to Create an Announcement](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-collaboration/add-announcement.md): Add announcements to asset pages to communicate updates, ownership changes, or data quality notes to users. ### Context Center #### Context Center - [Context Center](https://docs.open-metadata.org/v2.0.x/how-to-guides/context-center.md): A shared home for Articles, Memories, and Documents. MCP assistants can search Articles and read notes extracted from Documents. - [Articles](https://docs.open-metadata.org/v2.0.x/how-to-guides/context-center/articles.md): Long-form pages your team writes and maintains. - [Memories](https://docs.open-metadata.org/v2.0.x/how-to-guides/context-center/memories.md): Facts, definitions, and preferences your team can capture in Context Center. - [Documents and Archive](https://docs.open-metadata.org/v2.0.x/how-to-guides/context-center/documents.md): Upload and organize files. MCP assistants can retrieve question and answer notes extracted from uploaded files. ### Data Quality and Observability #### Data Quality and Observability - [Data Quality Observability Guide | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability.md): Step-by-step guidance for data quality observability using OpenMetadata. Learn key actions, features, and best practices. ##### Data Quality - [Data Quality | OpenMetadata Quality Management Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality.md): Ensure observability through alerts, test results, and profiler signals for better data quality. - [Data Quality Tab | OpenMetadata Quality Interface](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/tab.md): Use the quality tab to review profiling results, detect issues, and verify test coverage for your datasets. - [Create Quality Test Cases](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/test.md): Create no-code data quality tests at the table, column, and dimension level from the OpenMetadata UI, schedule runs, and review results. - [Adding test suites through the UI](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/adding-test-suites.md): Create a Bundle Suite in OpenMetadata to group test cases from different tables under one alert, compare it with table test suites, and let owners manage tests. - [Configure Data Quality | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/configure.md): Set up and tune quality tests across datasets using custom rules, metrics, and alerting logic. - [Tests - YAML Config | OpenMetadata Quality Config Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/tests-yaml.md): Define YAML tests to validate data quality during ingestion and enforce expectations at column or table level. - [Column Tests - YAML Config | OpenMetadata Quality Config Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/tests-yaml-column-tests.md): Configure column-level data quality tests in YAML to validate uniqueness, null values, regex patterns, value sets, and statistical properties. - [Adding Data Quality Test Cases from yaml config](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/test-cases-from-yaml-config.md): Define OpenMetadata data quality test cases in a YAML config with a TestSuite source and the orm-test-runner processor, then run the test workflow from the CLI. - [Dimensional Validation | Data Quality Testing by Dimension](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/dimensional-validation.md): Run data quality tests grouped by business dimensions to identify problem segments in your data. - [Custom Tests | OpenMetadata Quality Testing Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/custom-tests.md): Build and manage custom data quality tests to validate schema, values, and distributions during ingestion. - [Test Library | Custom SQL-Based Data Quality Tests](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/test-library.md): Create reusable custom data quality tests using SQL queries with dynamic parameters for table and column-level validations. - [How to Visualize Test Results](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/visualize.md): View OpenMetadata data quality test results from the Quality page by entity, test suite, or test case, or from a table's profiler and data quality tab. ###### Tests - UI Config - [Tests - UI Config | OpenMetadata Quality Config Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/tests-ui.md): Define UI tests to validate data quality during ingestion and enforce expectations at column or table level. - [Column Tests - UI Config | OpenMetadata Quality Config Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/tests-ui/column-tests.md): Configure column-level data quality tests in the OpenMetadata UI, covering uniqueness, nullness, regex, and range checks. ###### Data Quality as Code - [Data Quality as Code](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code.md): Run data quality tests programmatically from your ETL workflows using the OpenMetadata Python SDK - [Getting Started with Data Quality as Code](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/getting-started.md): Install the OpenMetadata Python SDK and configure authentication - [TestRunner - Running Table-Level Tests](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-runner.md): Execute data quality tests against tables in OpenMetadata using the TestRunner API - [DataFrame Validation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/dataframe-validation.md): Validate pandas DataFrames before loading them to destinations using OpenMetadata data quality tests - [DataFrame Chunk-Based Validation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/dataframe-validation-chunking.md): Validate large pandas DataFrames in memory-efficient chunks using OpenMetadata data quality tests with transactional safety. - [Advanced Usage](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/advanced-usage.md): Advanced patterns and configurations for Data Quality as Code - [Publishing Results & Best Practices](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/publishing-and-best-practices.md): Publish data quality results to OpenMetadata, implement error handling, generate tests dynamically, and apply best practices for production workflows. ###### Test Definitions - [Test Definitions Reference](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions.md): Complete reference for all data quality test types available in the OpenMetadata Python SDK - [Column-Level Test Definitions Reference](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions/column-tests.md): Complete reference for all column-level data quality test types available in the OpenMetadata Python SDK ###### Bulk Import, Export, and Edit Test Cases - [Bulk Import, Export, and Edit Test Cases](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/import-export-test-cases.md): Overview of bulk importing, exporting, and editing data quality test cases in OpenMetadata using CSV files. - [Bulk Import Test Cases](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/import-export-test-cases/import.md): Learn to bulk import data quality test cases in OpenMetadata using CSV files, at the table, test suite, or platform-wide scope. - [Bulk Export Test Cases](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/import-export-test-cases/export.md): Learn to bulk export data quality test cases in OpenMetadata as CSV files, at the table, test suite, or platform-wide scope. - [Bulk Edit Test Cases](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/import-export-test-cases/edit.md): Learn to bulk edit multiple data quality test cases at once in OpenMetadata using an inline spreadsheet grid, at the table, test suite, or platform-wide scope. ##### Data Profiler - [Data Profiler | OpenMetadata Data Profiling Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/profiler.md): Explore profiling workflows including histogram metrics, null counts, and field-level health. - [Profiler Tab | OpenMetadata Data Profiling Interface](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/profiler/tab.md): Use the profiler tab to configure, view, and manage profiling metrics including null counts, uniqueness, and stats. - [Profiler Workflow | OpenMetadata Profiling Workflow](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/profiler/profiler-workflow.md): Use profiler workflows to extract row stats, distribution, null percentages, and data health. - [Metrics | OpenMetadata Profiler Metrics Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/profiler/metrics.md): Monitor profiling metrics such as completeness, distinct counts, min/max, and type inference to detect data quality issues. - [Custom Metrics](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/profiler/custom-metrics.md): Define custom table-level and column-level profiler metrics with SQL in OpenMetadata, run the Profiler Agent, and view the computed values in the profile tabs. - [External Profiler Workflow | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/profiler/external-workflow.md): Trigger external profiling workflows to capture custom metrics and analyze datasets based on business context. ##### Alerts & Notifications - [Alerts & Notifications | OpenMetadata Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications.md): Configure alerts and notifications for data observability and system governance events across your data catalog. - [Data Observability Alerts | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/data-observability-alerts.md): Configure alerts for data quality failures, schema changes, and pipeline issues. - [System & Governance Notifications | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/system-governance-notifications.md): Configure notifications for metadata changes, governance events, and collaboration activities. - [Email Alerts Configuration | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/email-alerts-configuration.md): Configure email as an alert destination in OpenMetadata. - [Slack Alerts Configuration | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/slack-alerts-configuration.md): Configure Slack as an alert destination in OpenMetadata. - [Microsoft Teams Alerts Configuration | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/microsoft-teams-alerts-configuration.md): Configure Microsoft Teams as an alert destination in OpenMetadata. - [Google Chat Alerts Configuration | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/google-chat-alerts-configuration.md): Configure Google Chat as an alert destination in OpenMetadata. - [Generic Webhook Alert Configuration | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/generic-webhook-alerts-configuration.md): Configure generic webhooks as an alert destination in OpenMetadata. - [Alert Behavior Reference | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/alert-behavior-reference.md): Reference for how OpenMetadata alerts work, including the sources, triggers, and filters available for each alert type, exactly when an alert fires, and how Observability alerts differ from Notification alerts. - [Webhook Payloads and Delivery | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/webhook-payloads-and-delivery.md): Reference for the payload OpenMetadata sends to a webhook for each alert source and event type, plus authentication, timeouts, failure handling, duplicate delivery, and ordering. - [Notify Downstream | OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/alerts-notifications/notify-downstream.md): Send an alert to the owners and other stakeholders of downstream assets when an upstream asset or data product changes, using lineage. ##### Incident Manager - [Incident Manager | OpenMetadata Data Quality Management](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/incident-manager.md): Navigate the incident manager to assign, investigate, and resolve data quality incidents. - [How to work with the Incident Manager | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/incident-manager/workflow.md): Explore incident workflows that document, notify, and assign resolution steps for quality issues across assets. ### Data Lineage #### Data Lineage - [Data Lineage | OpenMetadata Lineage How-To Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-lineage.md): Navigate core data lineage guides to understand column, table, and pipeline lineage configuration. - [How to Deploy a Lineage Workflow](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-lineage/workflow.md): Build data lineage using workflows to extract upstream and downstream dependencies. - [Cross Database Lineage](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-lineage/cross-database-lineage.md): Learn how OpenMetadata resolves lineage across multiple databases or projects without requiring cross-service access. - [OpenLineage Compatibility](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-lineage/openlineage.md): Send OpenLineage events to OpenMetadata and understand dataset resolution, supported facets, and ingestion limits. - [Explore the Lineage View | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-lineage/explore.md): Explore lineage diagrams interactively to understand how data flows between sources, transformations, and dashboards. - [How Column-Level Lineage Works | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-lineage/column.md): View column-level lineage to trace transformations and dependencies for data quality, debugging, and impact analysis. - [How to Manually Add or Edit Lineage](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-lineage/manual.md): Manually build lineage by defining upstream and downstream relationships between datasets and transformations. ### Data Insights #### Data Insights - [Data Insights | OpenMetadata Reporting & Insights](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights.md): Step-by-step guidance for data insights using OpenMetadata. Learn key actions, features, and best practices. - [What is Tiering | OpenMetadata Data Tiering Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/tiering.md): Tier datasets based on usage, freshness, and governance to guide discovery and prioritization. - [Set Up Data Insights Ingestion | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/ingestion.md): Monitor ingestion metrics, failures, and progress from scheduled and triggered ingestion workflows. - [Key Performance Indicators (KPI) | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/kpi.md): Track key KPIs and data quality signals for datasets, services, and domains through governance dashboards. - [Run Elasticsearch Reindex using Airflow SDK](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/elasticsearch-reindex.md): Run the OpenMetadata Elasticsearch reindex workflow from Airflow by defining the metadata_elasticsearch YAML config and preparing a Python ingestion DAG. - [Data Insights Report | OpenMetadata Reporting Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/report.md): Generate data usage reports across domains, ownership, or profiling health to track data engagement. - [Configure the Data Insights Report](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/email-report.md): Set up email-based delivery of data insight reports for stakeholders and teams. - [How to Transform the Data Culture of Your Company](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/data-culture.md): Promote a data-driven culture with trust signals, ownership indicators, and contribution activity. - [Service Insights Overview | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-insights/service-insights.md): Explore service-level insights including ownership, usage, and performance metrics from data assets. ### Data Marketplace #### Data Marketplace - [Domains & Data Products | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-marketplace.md): Manage domains and data products to establish ownership, scope, and data product lineage within your ecosystem. - [Domains](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-marketplace/domains.md): Organize datasets into domains to group related data assets, assign responsibilities, and support distributed data ownership. - [Data Products](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-marketplace/data-products.md): Define and manage data products as part of your governance strategy to track ownership, value, and metadata lineage efficiently. ### Data Governance #### Data Governance - [Data Governance | OpenMetadata Governance Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance.md): Step-by-step guidance for data governance using OpenMetadata. Learn key actions, features, and best practices. - [Intake Forms | OpenMetadata Governance Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/intake-forms.md): Require specific fields to be filled in before a Data Product, Domain, or Glossary Term can be created or updated using Intake Forms. - [Metrics for OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/metrics.md): Define and govern business metrics in OpenMetadata: metric properties, lineage to data assets and other metrics, creation from the UI, and best practices. - [Column Bulk Operations for OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/column-bulk-operations.md): Update names, descriptions, tags, and glossary terms on matching columns across many tables with the deprecated Column Bulk Operations feature in OpenMetadata. ##### Glossary - [Glossary | OpenMetadata Data Glossary Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary.md): Set up glossary terms and definitions to improve search, categorization, and shared understanding. - [What is a Glossary Term | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/glossary-term.md): Create glossary terms with definitions, synonyms, status, and linked entities to support semantic understanding. - [How to Setup a Glossary | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/setup.md): Set up the glossary module with term hierarchies, reviewers, definitions, and asset links to support governance. - [How to Create Glossary Terms | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/create-terms.md): Learn to create terms within glossary hierarchies and assign owners, reviewers, and asset relationships. - [How to Bulk Import a Glossary](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/import.md): Import glossary terms in bulk using templates to streamline setup, migration, and cross-system integration. - [Glossary Export | OpenMetadata Export Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/export.md): Export glossary terms in bulk for backup, migration, or sharing with stakeholders or external systems. - [Glossary Approval Workflow | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/approval.md): Approve glossary terms for publishing after peer review to maintain high-quality, validated business definitions. - [Data Governance Glossary Troubleshooting | OpenMetadata Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/troubleshooting.md): Fix OpenMetadata glossary import and export jobs stuck in progress behind an NGINX HTTPS proxy by enabling WebSocket upgrade headers in the NGINX config. - [Glossary Styling | OpenMetadata Glossary Customization](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/styling.md): Style your glossary with custom headers, icons, and formats to reflect organizational tone and branding. - [How to Add Assets to Glossary Terms](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/assets.md): Link glossary terms to assets so users can explore definitions directly from datasets, dashboards, and columns. - [Best Practices for Glossary | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/glossary/best-practices.md): Apply best practices for creating glossary terms to ensure consistency, clarity, and shared understanding across teams. ##### Classification - [Classification | OpenMetadata Data Classification Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification.md): Learn how to classify data using tags, tiers, and rules to improve governance, discovery, and sensitivity tracking. - [Overview of Classification | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/classification.md): Get an overview of classification features to understand how data is organized, labeled, and governed across your OpenMetadata. - [Manage Classification](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/manage-classification.md): Add, edit, delete, export, and import classifications to keep your tagging taxonomy organized. - [How to Classify Data Assets | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/assets.md): Manage classification of assets such as tables and dashboards to enhance discoverability, quality, and trust in your data. - [How to Request for Classification Tags | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/request-tags.md): Use request tags to improve collaboration and feedback on data assets by enabling users to flag and annotate classification needs. - [Sample Data Handling Using PII Tags](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md): How OpenMetadata masks sample data when PII tags are applied to a column or a whole table, how to apply PII tags, and how access control affects masked values. - [What are Tiers | OpenMetadata Classification Tiers Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/tiers.md): Use tier-based classification to rank assets by quality, importance, and readiness for business consumption. - [Best Practices for Classification | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/best-practices.md): Follow classification best practices to ensure your data is consistently tagged, categorized, and compliant with governance rules. ###### Auto-Classification Workflow - [Auto-Classification in OpenMetadata](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/auto-classification.md): Learn how OpenMetadata automatically detects and tags sensitive data like PII using column name scanning and NLP-based entity recognition. - [Adding Auto Classification Workflow through UI](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/auto-classification/workflow.md): Add an Auto Classification agent to a database service from the OpenMetadata UI Agents tab, configure its details and sample data option, and schedule it. - [External Auto Classification Workflow](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/auto-classification/external-workflow.md): Run the OpenMetadata Auto Classification workflow externally, and configure confidence, storeSampleData, classification filter patterns, and FQN filtering. - [Auto Pii Tagging Guide | Official Documentation](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/classification/auto-classification/auto-pii-tagging.md): Automatically tag personally identifiable information (PII) in your datasets to support data classification, compliance, and privacy enforcement. ##### Ontology - [Ontology Explorer | OpenMetadata Knowledge Graph Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/ontology/index.md): Visualize your Glossary as an interactive knowledge graph and explore the relationships between terms using the Ontology Explorer. - [Manage Relation Types | OpenMetadata Ontology Explorer Guide](https://docs.open-metadata.org/v2.0.x/how-to-guides/data-governance/ontology/relationship-types.md): Configure the relationship types available between Glossary terms, including custom types with cardinality, RDF mapping, and color coding. ### Releases #### Releases - [Latest Release Notes | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases.md): Discover the latest OpenMetadata releases, new features, bug fixes, and updates. Stay current with release notes and upgrade information. ##### All Release Notes - [2.0 Release | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/2.0-release.md): Release notes for OpenMetadata 2.0 and its patch releases, covering new features, improvements, fixes, and a link to upgrade your instance. - [1.13 Release | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/1.13-release.md): Release notes for OpenMetadata 1.13 and its patch releases, listing new features, improvements, and bug fixes in each version. - [1.12 Release | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/1.12-release.md): OpenMetadata 1.12 release series changelog — new features, bug fixes, and upgrade guides for all 1.12.x versions. - [1.11 Release | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/1.11-release.md): OpenMetadata 1.11 release series changelog — new features, bug fixes, and upgrade guides for all 1.11.x versions. - [1.10 Release | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/1.10-release.md): OpenMetadata 1.10 release series changelog — new features, bug fixes, and upgrade guides for all 1.10.x versions. - [1.9 Release | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/1.9-release.md): OpenMetadata 1.9 release series changelog — new features, bug fixes, and upgrade guides for all 1.9.x versions. - [1.8 Release | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/1.8-release.md): OpenMetadata 1.8 release series changelog — new features, bug fixes, and upgrade guides for all 1.8.x versions. - [Old Releases | OpenMetadata](https://docs.open-metadata.org/v2.0.x/releases/old-releases.md): OpenMetadata legacy release notes — changelogs and upgrade guides for versions 1.7.x and earlier. ### Developers #### Developers - [OpenMetadata Developers | Developer Resources Overview](https://docs.open-metadata.org/v2.0.x/developers.md): Learn how to build, extend, and contribute to the metadata platform using developer best practices and APIs. - [Open Source Community | Official Documentation](https://docs.open-metadata.org/v2.0.x/developers/open-source-community.md): Explore how to contribute to the open-source community, including issues, pull requests, and collaboration. - [How to Set Up Bots | OpenMetadata Developer Guide](https://docs.open-metadata.org/v2.0.x/developers/bots.md): Create and manage bots for task automation, data notifications, and metadata workflows. - [How To Add Language Support | Official Documentation](https://docs.open-metadata.org/v2.0.x/developers/how-to-add-language-support.md): Add support for additional languages to extend platform accessibility and usability across global teams. - [How to Add a Custom Property to an Entity with API](https://docs.open-metadata.org/v2.0.x/developers/custom-properties.md): Learn how to add custom metadata properties to an entity to extend its structure and capture new details. ##### Architecture - [OpenMetadata System Architecture | Developer Guide](https://docs.open-metadata.org/v2.0.x/developers/architecture.md): Connect Architecture to enable streamlined access, monitoring, or search of enterprise data using secure and scalable integrations. - [Understand Code Layout](https://docs.open-metadata.org/v2.0.x/developers/architecture/code-layout.md): Guide to the OpenMetadata code layout: JSON Schema entity and type models, API request objects, REST APIs, and components such as events, search, and auth. ##### Contribute - [How to Contribute Code | Open Source Contribution Guide](https://docs.open-metadata.org/v2.0.x/developers/contribute.md): Understand contribution guidelines for participating in the platform's development and submitting changes. - [Development Environment Setup | Dev Containers for OpenMetadata](https://docs.open-metadata.org/v2.0.x/developers/contribute/development-environment-setup.md): Set up your OpenMetadata development environment using Dev Containers in VS Code, IntelliJ IDEA, or GitHub Codespaces. ###### Build the Code and Run Tests - [Prerequisites | OpenMetadata Developer Setup Requirements](https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/prerequisites.md): Complete prerequisite steps for contributing code including environment, dependencies, and access setup. - [OpenMetadata Server | Developer Guide & Setup](https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/openmetadata-server.md): Build and run metadata server locally with this guide, including environment setup and server configuration tips. - [Ingestion Framework | OpenMetadata Developer Guide](https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/ingestion-framework.md): Contribute to ingestion framework by setting up the local dev environment, running tests, and validating workflows. - [Generate TypeScript Types From JSON Schema](https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/generate-typescript-types-from-json-schema.md): Use this guide to generate TypeScript type definitions from JSON Schema to maintain consistency and type safety. - [OpenMetadata UI | Developer Guide & Setup](https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/openmetadata-ui.md): Build and test the metadata UI locally by setting up this frontend development environment guide. - [Playwright Integration Tests | Official Documentation](https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/playwright-integration-tests.md): Setup Playwright test framework and configure automated end-to-end test suite for validating platform components. ###### Codebase Deep Dives - [Data Quality Module | Technical Architecture](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/data-quality.md): Technical deep dive into the OpenMetadata data quality module — test execution pipeline, validator architecture, and extension points. - [Profiler Module | Architecture & Metrics System](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/profiler.md): Technical deep dive into the OpenMetadata profiler — metrics system, computation engine, and workflow architecture. - [Profiler Module | Execution & Extension](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/profiler-execution.md): Technical deep dive into the OpenMetadata profiler — execution call chain, threading model, metric filtering, ORM layer, and extension points. - [Sampler Module | Technical Architecture](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/sampler.md): Technical deep dive into the OpenMetadata sampler — sampling strategies, database-specific implementations, and integration with profiler and data quality. - [Metadata Ingestion | Technical Architecture](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/metadata-ingestion.md): Technical deep dive into the OpenMetadata metadata ingestion framework — topology-based execution, source hierarchy, and how to add new connectors. - [Usage Ingestion | Technical Architecture](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/usage-ingestion.md): Technical deep dive into the OpenMetadata usage ingestion pipeline — query log collection, SQL parsing, aggregation, and publishing. ###### Lineage Ingestion - [Lineage Ingestion | Technical Architecture](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/lineage-ingestion.md): Technical deep dive into the OpenMetadata lineage ingestion pipeline — SQL parsing, graph analysis, column-level lineage, and cross-database lineage. - [Lineage Ingestion Advanced | Entity Resolution, Publishing & Configuration](https://docs.open-metadata.org/v2.0.x/developers/contribute/codebase-deep-dives/lineage-ingestion/advanced.md): Deep dive into entity resolution, cross-database lineage, stored procedures, parallel processing, and the full AddLineageRequest lifecycle. ###### Developing a New Connector - [Developing a new Connector](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector.md): Overview of contributing a new OpenMetadata connector, comparing AI-assisted and manual approaches and listing each step, using MySQL as the example. - [Define the JSON Schema](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/define-json-schema.md): Define the JSON Schema connection file for a new OpenMetadata connector, understand its anatomy, and make the connection available to the service definition. - [Develop the Ingestion Code](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/develop-ingestion-code.md): Write the Python ingestion code for a new OpenMetadata connector: the service_spec.py file, DefaultDatabaseSpec, the service topology, and the service source. - [Performance & Memory Management](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/performance-and-memory.md): Best practices for pagination, memory management, lookup optimization, and connection reuse in OpenMetadata ingestion connectors. - [Apply UI Changes](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/apply-ui-changes.md): Register a new connector's JSON Schema connection in the OpenMetadata UI service utils so it can be configured and tested in the UI, using MySQL as example. - [Create the Java ClassConverter](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/create-java-class-converter.md): Implement and register a Java ClassConverter for a new OpenMetadata connector whose JSON Schema uses oneOf, with MysqlConnectionClassConverter as reference. - [Test It](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/test-it.md): Test a new OpenMetadata connector with make generate, unit tests, the metadata ingest CLI, and the UI, plus AI-assisted Docker testing and code review. - [Update the Documentation](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/update-documentation.md): Document a new OpenMetadata connector by adding UI and YAML pages, updating the connectors list, menu, logo, and homepage list, and following doc guidelines. ###### AI-Assisted Development - [AI-Assisted Connector Development](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/ai-assisted-development.md): Build OpenMetadata connectors faster using AI skills with Claude Code, Cursor, Codex, and other AI tools - [Install AI Skills](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/ai-assisted-development/install-skills.md): Set up OpenMetadata connector skills in Claude Code, Cursor, Codex, Copilot, and other AI tools - [Scaffold a Connector](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/ai-assisted-development/scaffold-connector.md): Use the scaffold tool to generate JSON Schema, Python boilerplate, and AI implementation context for a new connector - [Build a Connector with AI](https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/ai-assisted-development/build-with-ai.md): End-to-end workflow for implementing an OpenMetadata connector using AI tools