# Table of contents

## 📌 Overview

* [Introduction](README.md)
* [Features](overview/features.md)
* [Roadmap](overview/roadmap.md)
* [Releases](overview/releases.md)
* [Try OpenMetadata in our Public Sandbox](overview/take-it-for-a-spin.md)
* [Try OpenMetadata in Docker](overview/run-openmetadata/README.md)
  * [Enable Security](overview/run-openmetadata/enable-security.md)
* [Tutorials](overview/tutorials/README.md)
  * [Tutorial: Data Discovery with OpenMetadata](overview/tutorials/tutorial-data-discovery-with-openmetadata.md)

## 📦 Integrations

* [Metadata Ingestion Overview](../metadata-ingestion/metadata-ingestion.md)
* [Connectors](integrations/connectors/README.md)
  * [Athena](integrations/connectors/athena.md)
  * [Azure SQL](integrations/connectors/azure-sql.md)
  * [BigQuery](integrations/connectors/bigquery/README.md)
    * [BigQuery Usage](integrations/connectors/bigquery/bigquery-usage.md)
    * [BigQuery in the UI](integrations/connectors/bigquery/bigquery-in-the-ui.md)
  * [ClickHouse](integrations/connectors/clickhouse/README.md)
    * [ClickHouse Metadata Extraction](integrations/connectors/clickhouse/clickhouse-metadata-extraction.md)
    * [ClickHouse Usage](integrations/connectors/clickhouse/clickhouse-usage.md)
  * [Databricks](integrations/connectors/databricks.md)
  * [DBT](integrations/connectors/dbt.md)
  * [Delta Lake](integrations/connectors/delta-lake.md)
  * [DynamoDB](integrations/connectors/dynamodb.md)
  * [Elasticsearch](integrations/connectors/elastic-search.md)
  * [Glue Catalog](integrations/connectors/glue-catalog/README.md)
    * [Glue Metadata Extraction](integrations/connectors/glue-catalog/glue-metadata-extraction.md)
  * [Hive](integrations/connectors/hive.md)
  * [IBM Db2](integrations/connectors/ibm-db2.md)
  * [Kafka](integrations/connectors/kafka.md)
  * [Looker](integrations/connectors/looker.md)
  * [MariaDB](integrations/connectors/mariadb.md)
  * [Metabase](integrations/connectors/metabase.md)
  * [MLflow](integrations/connectors/mlflow/README.md)
    * [MLflow Metadata Extraction](integrations/connectors/mlflow/mlflow-metadata-extraction.md)
  * [MSSQL](integrations/connectors/mssql/README.md)
    * [MSSQL Metadata Extraction](integrations/connectors/mssql/mssql-metadata-extraction.md)
    * [MSSQL Usage](integrations/connectors/mssql/mssql-usage.md)
  * [MySQL](integrations/connectors/mysql/README.md)
    * [MySQL Metadata Extraction](integrations/connectors/mysql/mysql.md)
  * [Oracle](integrations/connectors/oracle.md)
  * [Postgres](integrations/connectors/postgres/README.md)
    * [Postgres Metadata Extraction](integrations/connectors/postgres/postgres-metadata-extraction.md)
  * [Presto](integrations/connectors/presto.md)
  * [Redash](integrations/connectors/redash.md)
  * [Redshift](integrations/connectors/redshift/README.md)
    * [Redshift Metadata Extraction](integrations/connectors/redshift/redshift-metadata-extraction.md)
    * [Redshift Usage](integrations/connectors/redshift/redshift-usage.md)
  * [Salesforce](integrations/connectors/salesforce.md)
  * [SingleStore](integrations/connectors/singlestore.md)
  * [Snowflake](integrations/connectors/snowflake/README.md)
    * [Snowflake Usage](integrations/connectors/snowflake/snowflake-usage.md)
    * [Snowflake in the UI](integrations/connectors/snowflake/snowflake-metadata-extraction.md)
  * [Superset](integrations/connectors/superset.md)
  * [Tableau](integrations/connectors/tableau.md)
  * [Trino](integrations/connectors/trino.md)
  * [Vertica](integrations/connectors/vertica.md)
* [Troubleshoot Connectors](integrations/troubleshoot-connectors.md)
* [Ingest Metadata in Production](integrations/ingest-metadata-in-production.md)
* [Ingest Sample Data](../metadata-ingestion/ingest-sample-data.md)
* [Airflow](integrations/airflow/README.md)
  * [Custom Airflow Installation](integrations/airflow/custom-airflow-installation.md)
  * [Airflow Lineage](integrations/airflow/airflow-lineage.md)
  * [Configure Airflow in the OpenMetadata Server](integrations/airflow/configure-airflow-in-the-openmetadata-server.md)
  * [Example Metadata Ingestion](integrations/airflow/airflow.md)

## 📐 Metadata Standard

* [Schemas](openmetadata-apis/schemas/README.md)
  * [JSON Schema](openmetadata-apis/schemas/schema-language.md)
  * [Schema Concepts](openmetadata-apis/schemas/overview.md)
  * [OpenMetadata Types](openmetadata-apis/schemas/types/README.md)
    * [Audit Log](openmetadata-apis/schemas/types/auditlog.md)
    * [Basic Types](openmetadata-apis/schemas/types/basic.md)
    * [Change Event](openmetadata-apis/schemas/types/changeevent.md)
    * [Daily Count](openmetadata-apis/schemas/types/dailycount.md)
    * [Database Connection Configuration](openmetadata-apis/schemas/types/databaseconnectionconfig.md)
    * [Entity History](openmetadata-apis/schemas/types/entityhistory.md)
    * [Entity Lineage](openmetadata-apis/schemas/types/entitylineage.md)
    * [Entity Reference](openmetadata-apis/schemas/types/entityreference.md)
    * [Entity Relationship](openmetadata-apis/schemas/types/entityrelationship.md)
    * [Entity Usage](openmetadata-apis/schemas/types/entityusage.md)
    * [Include](openmetadata-apis/schemas/types/include.md)
    * [Jdbc Connection](openmetadata-apis/schemas/types/jdbcconnection.md)
    * [Paging](openmetadata-apis/schemas/types/paging.md)
    * [Profile](openmetadata-apis/schemas/types/profile.md)
    * [Schedule](openmetadata-apis/schemas/types/schedule.md)
    * [Storage](openmetadata-apis/schemas/types/storage.md)
    * [Tag Label](openmetadata-apis/schemas/types/taglabel.md)
    * [Usage Details](openmetadata-apis/schemas/types/usagedetails.md)
  * [OpenMetadata Entities](openmetadata-apis/schemas/entities/README.md)
    * [Access Control Rule](openmetadata-apis/schemas/entities/accesscontrolrule.md)
    * [Bot](openmetadata-apis/schemas/entities/bot.md)
    * [Chart](openmetadata-apis/schemas/entities/chart.md)
    * [Dashboard](openmetadata-apis/schemas/entities/dashboard.md)
    * [Dashboard Service](openmetadata-apis/schemas/entities/dashboardservice.md)
    * [Database](openmetadata-apis/schemas/entities/database.md)
    * [Database Service](openmetadata-apis/schemas/entities/databaseservice.md)
    * [Delete Action](openmetadata-apis/schemas/entities/deleteaction.md)
    * [Feed](openmetadata-apis/schemas/entities/thread.md)
    * [Filters](openmetadata-apis/schemas/entities/filters.md)
    * [Glossary](openmetadata-apis/schemas/entities/glossary.md)
    * [Glossary Term](openmetadata-apis/schemas/entities/glossaryterm.md)
    * [Location](openmetadata-apis/schemas/entities/location.md)
    * [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md)
    * [Metrics](openmetadata-apis/schemas/entities/metrics.md)
    * [ML Model](openmetadata-apis/schemas/entities/mlmodel.md)
    * [Move Action](openmetadata-apis/schemas/entities/moveaction.md)
    * [Pipeline](openmetadata-apis/schemas/entities/pipeline.md)
    * [Pipeline Service](openmetadata-apis/schemas/entities/pipelineservice.md)
    * [Policy](openmetadata-apis/schemas/entities/policy.md)
    * [Report](openmetadata-apis/schemas/entities/report.md)
    * [Role](openmetadata-apis/schemas/entities/role.md)
    * [Rule](openmetadata-apis/schemas/entities/rule.md)
    * [Storage Service](openmetadata-apis/schemas/entities/storageservice.md)
    * [Table](openmetadata-apis/schemas/entities/table.md)
    * [Tag Bases](openmetadata-apis/schemas/entities/tagbased.md)
    * [Tag Category](openmetadata-apis/schemas/entities/tagcategory.md)
    * [Task](openmetadata-apis/schemas/entities/task.md)
    * [Team](openmetadata-apis/schemas/entities/team.md)
    * [Topic](openmetadata-apis/schemas/entities/topic.md)
    * [User](openmetadata-apis/schemas/entities/user.md)
    * [Webhook](openmetadata-apis/schemas/entities/webhook.md)
* [APIs](openmetadata-apis/apis/README.md)
  * [Overview](openmetadata-apis/apis/overview.md)
  * [API Organization](openmetadata-apis/apis/api-organization.md)
  * [Implementation notes](openmetadata-apis/apis/implementation-notes.md)

## 🚀 Deploy

* [Local Deployment](deploy/local-deployment.md)
* [Deploy on Bare Metal](../deploy/deploy-on-bare-metal/README.md)
  * [Deploy OpenMetadata on Bare Metal](../deploy/deploy-on-bare-metal/run-in-production.md)
  * [Enable Security](../deploy/deploy-on-bare-metal/enable-security/README.md)
    * [Google SSO](../deploy/deploy-on-bare-metal/enable-security/google-sso/README.md)
      * [Create Server Credentials](../deploy/deploy-on-bare-metal/enable-security/google-sso/google-server-creds.md)
      * [Create Service Account](../deploy/deploy-on-bare-metal/enable-security/google-sso/create-ingestion-service-account.md)
      * [Configure OpenMetadata Server](../deploy/deploy-on-bare-metal/enable-security/google-sso/google-config.md)
      * [Configure Ingestion](../deploy/deploy-on-bare-metal/enable-security/google-sso/configure-security-ingestion.md)
    * [Okta SSO](../deploy/deploy-on-bare-metal/enable-security/okta-sso/README.md)
      * [Create Server Credentials](../deploy/deploy-on-bare-metal/enable-security/okta-sso/okta-server-creds.md)
      * [Configure OpenMetadata Server](../deploy/deploy-on-bare-metal/enable-security/okta-sso/okta-config.md)
      * [Create Service Application](../deploy/deploy-on-bare-metal/enable-security/okta-sso/create-ingestion-service-account.md)
      * [Configure Ingestion](../deploy/deploy-on-bare-metal/enable-security/okta-sso/configure-security-ingestion.md)
    * [Auth0 SSO](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/README.md)
      * [Create Server Credentials](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/auth0-server-creds.md)
      * [Create Service Account](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/create-ingestion-service-account.md)
      * [Configure OpenMetadata Server](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/auth0-config.md)
      * [Configure Ingestion](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/configure-security-ingestion.md)
* [Deploy on Kubernetes](../deploy/deploy-on-kubernetes/README.md)
  * [Deploy OpenMetadata on Kubernetes](../deploy/deploy-on-kubernetes/run-in-kubernetes.md)
  * [Values.yaml](../deploy/deploy-on-kubernetes/values.yaml.md)
  * [Enable Security](../deploy/deploy-on-kubernetes/enable-security/README.md)
    * [Google SSO](../deploy/deploy-on-kubernetes/enable-security/google-sso/README.md)
      * [Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-server-creds.md)
      * [Create Service Account](../deploy/deploy-on-kubernetes/enable-security/google-sso/create-ingestion-service-account.md)
      * [Configure OpenMetadata Helm](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-config.md)
      * [Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/google-sso/configure-security-ingestion.md)
    * [Okta SSO](../deploy/deploy-on-kubernetes/enable-security/okta-sso/README.md)
      * [Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-server-creds.md)
      * [Configure OpenMetadata Helm](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-config.md)
      * [Create Service Application](../deploy/deploy-on-kubernetes/enable-security/okta-sso/create-ingestion-service-account.md)
      * [Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/okta-sso/configure-security-ingestion.md)
    * [Auth0 SSO](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/README.md)
      * [Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-server-creds.md)
      * [Create Service Account](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/create-ingestion-service-account.md)
      * [Configure OpenMetadata Helm](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-config.md)
      * [Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/configure-security-ingestion.md)
* [Reference](../deploy/reference/README.md)
  * [Server Configuration Parameters](../deploy/reference/configuration.md)
  * [Connector Configuration Parameters](../deploy/reference/connector-configuration.md)

## 🧰 Upgrade

* [Upgrade on Bare Metal](../upgrade/upgrade-on-bare-metal/README.md)
  * [Backup Metadata](../upgrade/upgrade-on-bare-metal/backup-metadata.md)
  * [Upgrade OpenMetadata on Bare Metal](../upgrade/upgrade-on-bare-metal/upgrade-openmetadata.md)
* [Upgrade on Kubernetes](../upgrade/upgrade-on-kubernetes/README.md)
  * [Backup Metadata](../upgrade/upgrade-on-kubernetes/backup-metadata.md)
  * [Upgrade OpenMetadata on Kubernetes](../upgrade/upgrade-on-kubernetes/upgrade-openmetadata-on-kubernetes.md)

## 🔎 Data Discovery

* [Keyword Search](data-discovery/keyword-search.md)
* [Discovery through Association](data-discovery/discovery-through-association.md)
* [Advanced Search](data-discovery/advanced-search.md)
* [Complex Data Types](data-discovery/complex-data-types.md)
* [Deleted Entity Metadata](data-discovery/deleted-entity-metadata.md)

## 🤝 Data Collaboration

* [Activity Feeds](data-collaboration/activity-feeds.md)
* [Conversation Threads](data-collaboration/conversation-threads.md)
* [Descriptions and Tags](data-collaboration/descriptions-and-tags.md)
* [Data Importance](data-collaboration/data-importance.md)
* [Data Ownership](data-collaboration/data-ownership.md)

## 🌿 Data Lineage

* [Lineage Ingestion](data-lineage/lineage-ingestion.md)
* [Edit Data Lineage Manually](data-lineage/edit-data-lineage-manually.md)
* [DBT Integration](data-lineage/dbt-integration.md)

## 📗 Controlled Vocabulary

* [Glossaries](controlled-vocabulary/glossaries.md)

## ✅ Data Quality

* [Data Quality Overview](../data-quality/data-quality-overview/README.md)
  * [Metrics](../data-quality/data-quality-overview/metrics.md)
  * [Tests](../data-quality/data-quality-overview/tests.md)

## 🔢 Metadata Versioning

* [Metadata Versioning](metadata-versioning/metadata-versioning.md)
* [Change Feeds](metadata-versioning/change-feeds.md)
* [Change Events](metadata-versioning/change-events.md)
* [Event Notification via Webhooks](metadata-versioning/event-notification-via-webhooks.md)

***

* [👩💻 Developer](developer/README.md)
  * [Architecture](developer/architecture/README.md)
    * [Design](developer/architecture/solution-design.md)
    * [Understand Code Layout](developer/architecture/quick-start-guide.md)
    * [Entities](developer/architecture/entities/README.md)
      * [ML Model Entity](developer/architecture/entities/ml-model-entity.md)
  * [OpenMetadata SDK](developer/openmetadata-sdk/README.md)
    * [Python](developer/openmetadata-sdk/python-api.md)
    * [Java (Coming Soon)](developer/openmetadata-sdk/java-coming-soon.md)
  * [Build a Connector](developer/build-a-connector/README.md)
    * [Source](developer/build-a-connector/source.md)
    * [Sink](developer/build-a-connector/sink.md)
    * [Stage](developer/build-a-connector/stage.md)
    * [BulkSink](developer/build-a-connector/bulksink.md)
  * [How to Contribute](developer/how-to-contribute.md)
  * [Build Code and Run Tests](developer/build-code-and-run-tests/README.md)
    * [Prerequisites](developer/build-code-and-run-tests/prerequisites.md)
    * [OpenMetadata Server](developer/build-code-and-run-tests/openmetadata-server.md)
    * [Ingestion Framework](developer/build-code-and-run-tests/ingestion-framework.md)
    * [OpenMetadata UI](developer/build-code-and-run-tests/ui.md)
    * [Backend](developer/build-code-and-run-tests/backend.md)
  * [UX Style Guide](developer/ux-style-guide.md)
* [🎆 Open Source Community](open-source-community.md)