> ## Documentation Index > Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt > Use this file to discover all available pages before exploring further. # Databend Connector | OpenMetadata Database Integration > Connect Databend to OpenMetadata with the database connector guide. Step-by-step setup, configuration examples, and metadata extraction tips. ![Databend](https://docs.open-metadata.org/public/images/connectors/databend.webp) # Databend BETA This section provides guides and references to use the Databend connector. Configure and schedule Databend metadata and profiler workflows from the OpenMetadata UI: * [Requirements](#requirements) * [Profiler and Data Quality](#profiler-and-data-quality) * [Metadata Ingestion](#metadata-ingestion) * [Troubleshooting](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/database/databend/troubleshooting.md) ## Requirements OpenMetadata connects to the Databend HTTP query service with a SQLAlchemy driver, using a username and password. The connecting user must be able to read the system and `information_schema` metadata, and to read the databases and tables you want to ingest. ### Entity Mapping OpenMetadata ingests only the Databend `default` catalog. Databend objects map to OpenMetadata entities as follows: | Databend | OpenMetadata | | - | - | | Catalog (`default`) | Database | | Database | Schema | | Tables and views | Tables | ### Profiler and Data Quality Running the profiler workflow, data quality tests, or data diff requires `SELECT` on the tables and schemas being profiled or tested. For more information, see [Profiler Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow.md) and [Data Quality](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/quality.md). ## Metadata Ingestion To ingest metadata from Databend, you need to create a service connection. The service connects Databend with OpenMetadata. After you create the service and deploy the metadata agent, OpenMetadata starts ingesting metadata. ### Step 1: Add New Service 1. Navigate to **Settings** > **Services**. ![Navigate to Settings and Services](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/access-services.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=c95e6e79c73eea68039c10115c7f80d6) 2. Click **Add New Service**. ![Add New Service](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/add-new-service.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=13457ef6e565aa39d339db30ce1f354d) ### Step 2: Select a Service and Connector From the service type dropdown, select **Database Services**, then click the **Databend** connector tile. ![Select Service](https://mintcdn.com/openmetadata/jgI2hJajITOPm-1s/public/images/connector2.0/metadata-ingestion/Database/select-service/databend.png?fit=max\&auto=format\&n=jgI2hJajITOPm-1s\&q=85\&s=a577aa6a11d2476a2fc8ee888b45fc58) ### Step 3: Add Service Name and Description * Enter a unique, descriptive **Service Name**. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other Databend services you're ingesting metadata from. * Optional: Enter a **Description** for the service. ![Add New Service Name](https://mintcdn.com/openmetadata/jgI2hJajITOPm-1s/public/images/connector2.0/metadata-ingestion/Database/service-name/databend.png?fit=max\&auto=format\&n=jgI2hJajITOPm-1s\&q=85\&s=b7a02f912d210e379f3e09793fe0320a) > [!NOTE] > > The service name can't be changed after it's set. ### Step 4: Configure Connection Options Specify your source credentials and verify the connection. #### Enter Connection Details Enter the connection details for Databend. The inline help panel in the UI describes each field. The form groups fields into **Connection**, **Authentication**, **Scope & Options**, and **Advanced Config** sections. ![Configure Service Connection](https://mintcdn.com/openmetadata/4aWawxkY1I-3Akkr/public/images/connector2.0/metadata-ingestion/Database/connection-details/databend.png?fit=max\&auto=format\&n=4aWawxkY1I-3Akkr\&q=85\&s=1f442cfb37e379e0884e8e484a8468ec) * **Username** (required): Username to connect to Databend. The user must be able to read system and `information_schema` metadata. * **Host and Port** (required): Host and port of the Databend HTTP query service. The default self-hosted port is `8000`, and the field is prefilled with `localhost:8000`. * **Password** (required): Password to connect to Databend. Expand **Scope & Options** and **Advanced Config** to set the optional fields: ![Scope and Advanced Config](https://mintcdn.com/openmetadata/4aWawxkY1I-3Akkr/public/images/connector2.0/metadata-ingestion/Database/connection-details/databend-advanced.png?fit=max\&auto=format\&n=4aWawxkY1I-3Akkr\&q=85\&s=184ab8834999956bcd453709d7572e45) * **Database Schema** (optional): A single Databend database to ingest. It is also used as the initial database of the connection. When left blank, the connection starts in the `default` database and OpenMetadata scans all accessible Databend databases as schemas. * **Connection Scheme** (optional): SQLAlchemy driver scheme. The only option is `databend`, which is the default. * **Connection Options** (optional): Additional options appended to the Databend connection URL. For a non-TLS HTTP endpoint, such as the default self-hosted port `8000`, add `sslmode` with the value `disable`. For a TLS endpoint, set `sslmode` to `enable`. * **Connection Arguments** (optional): Additional arguments passed to the driver. > [!NOTE] > > **Note**: The **Default Database Filter Pattern** has no effect beyond the `default` catalog, because OpenMetadata ingests only that catalog. #### Test Connection After you add the credentials, click **Test Connection**, then click **Save**. ![Test Connection](https://mintcdn.com/openmetadata/9G75p72jJKYgvFUQ/public/images/connectors/test-connection.png?fit=max\&auto=format\&n=9G75p72jJKYgvFUQ\&q=85\&s=4ac71a56e30fa3dd1be86f82c1f07068) ### Step 5: Configure Ingestion Options In the **What to Ingest** step, configure filter rules for databases, schemas, and tables. #### How Filter Rules Work Each rule matches asset names using one of five match types: * **Contains**: Matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`. * **Starts with**: Matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`. * **Ends with**: Matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`. * **Is exactly**: Matches the exact name only. For example, `analytics` matches only `analytics`. * **Matches regex**: Matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`. When include rules and exclude rules both match an asset, the exclude rule takes priority. > [!TIP] > > Leave all filter rules empty to ingest all databases, schemas, and tables available in the source. #### Filter Options The **Database**, **Schema**, and **Table** sections control ingestion for the corresponding asset type. Each section provides the following controls: * **Scan Mode**: Choose one of the following scan modes: * **Scan all**: Ingests every asset of that type the connector can access. This is the default. * **Only specific**: Enables include rules so only assets matching at least one rule are ingested. * **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector, for example, **Exclude system databases** for the Databases section. * **Always exclude**: Add permanent exclusion rules (shown in red). OpenMetadata never ingests assets matching these rules, regardless of include rules. * **Preview**: View a real-time summary of what's in scope based on your current rules. * **Include rules**: In **Only specific** mode, click **+ Add** to define a rule. Added rules appear as chips. OpenMetadata includes an asset if it matches any rule. ### Step 6: Create & Deploy Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. OpenMetadata saves the service configuration and immediately begins pulling metadata from the source. To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service. ## Configure Metadata Agent and Schedule Ingestion The **Metadata Agent** extracts schemas, tables, columns, and other structural metadata from your source and keeps your OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click **Create & Deploy**, OpenMetadata automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page. To configure the additional Metadata Agent and schedule ingestion, follow these steps: 1. Navigate to **Settings** > **Services** and select the service type. ![Navigate to Settings and Services](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/access-service-type.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=4471655da6e39d91776597e4a7eea513) 2. Click the service you have added. 3. Select the **Agents** tab and click **Add Agent** > **Metadata**. ![Add Metadata Agent](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/add-metadata-agent.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=a654d9700126ce64cb6c9a99b8d69b1a) For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page. 4. On the **Configure Ingestion** page, do the following and click **Next**. * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline. ![Name this Ingestion](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/metadata-agent-name.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=92954c166518e3ac07589ab20865e3e7) * **Agent Setup**: Configure core parameters for metadata extraction. The following fields are available: | Field | Default | Description | | - | - | - | | **Default Owner** | — | Owner applied to any entity that has no owner from a more specific field below. Accepts a user or a team, by name or email. | | **Service Owner** | — | Owner assigned to the service entity itself (the connector/service you're setting up, not the data inside it). | | **Database Owner** | — | Owner assigned to every database this agent ingests. Accepts either one owner for all of them, or a mapping of specific owners per database. | | **Database Schema Owner** | — | Owner assigned to every schema this agent ingests. Accepts either one owner for all of them, or a mapping of specific owners per schema. | | **Table Owner** | — | Owner assigned to every table this agent ingests. Accepts either one owner for all of them, or a mapping of specific owners per table. | | **Enable Inheritance** | On | When on, an entity with no owner of its own inherits one from the nearest parent that has one, checked in this order: table, then schema, then database, then service, then Default Owner. Turn off if you want only the owners set explicitly above to apply, with no fallback. | | **Query Log Duration** | 1 | How many days of query logs to look back through when processing stored procedure results. | | **Query Parsing Timeout Limit** | 300 | How many seconds to spend parsing a single query before giving up on it and moving to the next. Raise this if large or complex queries are being skipped. | | **Number of Threads** | 1 | How many tables to ingest in parallel. Raising this can speed up ingestion on databases with many tables, at the cost of more load on the source. | | **Incremental Extraction** | Off | When on, a run extracts only entities that changed since the last successful run, instead of re-scanning everything every time. Faster on large, mostly unchanged databases. | | **Successful Pipeline Run Lookback Days** | 7 | Only used when Incremental Extraction is on. How many days back to search for a prior successful run to use as the starting point for what changed since then. | | **Safety Margin Days** | 1 | Only used when Incremental Extraction is on. Extra days added before that starting point, as a buffer so changes still in flight when the last run finished aren't missed. | | **Extract JSON Schema** | Off | Sample values in JSON columns to infer and ingest their schema, so the individual fields inside a JSON column are visible in OpenMetadata rather than just "JSON". Requires `SELECT` permission on the sampled tables. If that permission is missing, the JSON column is still ingested, just without a detailed schema. | | **JSON Schema Sample Size** | 10 | Only used when Extract JSON Schema is on. Number of rows sampled per JSON column to infer its schema. A larger sample gives more accurate results but takes longer to run. | | **Max Schema Inference Depth** | No limit | Maximum nesting depth of the child columns OpenMetadata infers from sampled JSON values. The direct children of a column are depth `1`. Deeper children are not ingested, and a column at the limit keeps its data type without children. `0` keeps no inferred children. Leave empty for no limit. | | **Max Children Per Column** | No limit | Maximum number of direct children kept for any inferred column, applied at every nesting level. When a column has more, OpenMetadata keeps the children whose names sort first, so every run keeps the same children. `0` keeps no inferred children. Leave empty for no limit. | The limits apply to child columns OpenMetadata infers from sampled JSON values: JSON files and JSONL files in data lakes, JSON values inside CSV and TSV cells, NoSQL documents, and JSON columns when **Extract JSON Schema** is on. Declared schemas, such as JSON Schema, Avro, Parquet, Iceberg, and Delta metadata, are never limited. OpenMetadata logs one warning per table that names the affected columns. For more information about how the Default Owner, Service Owner, Database Owner, Database Schema Owner, Table Owner, and Enable Inheritance fields resolve an owner, see [Hierarchical Owner Configuration](https://docs.open-metadata.org/connectors/ingestion/workflows/metadata/hierarchical-owner-configuration.md). ![Agent Setup](https://mintcdn.com/openmetadata/oUGf8BeSz2Uo7tlL/public/images/connector2.0/metadata-ingestion/Database/database-agent-setup.png?fit=max\&auto=format\&n=oUGf8BeSz2Uo7tlL\&q=85\&s=d0b1251c1b9aacd64c95278645f89127) * **Filter Patterns**: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. For more information about various filter options, see **Step 6: Configure Ingestion Options**. ![Filter Patterns](https://mintcdn.com/openmetadata/oUGf8BeSz2Uo7tlL/public/images/connector2.0/metadata-ingestion/Database/database-filter-pattern.png?fit=max\&auto=format\&n=oUGf8BeSz2Uo7tlL\&q=85\&s=cc4693554363e81232fde8c3fb602e25) * **Scope & Behaviour**: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs: | Toggle | Default | Description | | - | - | - | | **Include Tables** | On | Ingest tables and their columns. Turn off to skip tables entirely, for example if this agent exists only to pull tags or stored procedures. | | **Include Tags** | On | Ingest tags already defined on tables/columns in the source system (for example, a classification tag applied in Snowflake) and bring them into OpenMetadata as tags on the same assets. | | **Include Stored Procedures** | On | Ingest stored procedures as their own assets, so they show up in the catalog and can be linked into lineage. | | **Include DDL Statements** | Off | Also ingest the raw `CREATE TABLE` / `CREATE VIEW` statement for each asset, so it's viewable in OpenMetadata alongside the asset's metadata. | | **Include Owners** | Off | When an ingested asset's owner in the source system is an email that matches an existing OpenMetadata user, assign that user as the asset's owner. Never overwrites an owner an asset already has in OpenMetadata. | | **Include Custom Properties** | Off | Ingest source-specific metadata that doesn't map to a standard OpenMetadata field (for example, a database-specific attribute) into custom properties on the asset, if custom properties have been defined for that entity type. | | **Mark Deleted Tables** | On | If a table this agent previously ingested no longer exists in the source, soft-delete it in OpenMetadata too. Only affects tables within schemas this agent actually scans. | | **Mark Deleted Stored Procedures** | On | Same as Mark Deleted Tables, but for stored procedures. | | **Mark Deleted Schemas** | Off | If an entire schema this agent previously ingested no longer exists in the source, soft-delete the schema and everything in it. | | **Mark Deleted Databases** | Off | If an entire database this agent previously ingested no longer exists in the source, soft-delete the database and everything in it. | | **Override Metadata** | Off | On: values from the source (descriptions, tags, owners, display names) overwrite what's currently in OpenMetadata, even if someone edited it there. A description or display name that the source doesn't send never replaces an existing value, and existing table constraints are kept when the source sends none. Override replaces tags only within the classifications the source sends, so tags from other classifications and glossary terms are kept. Retention periods that users set are kept. If the connector supplies custom properties, the values it sends are merged over the existing ones: properties the source sends overwrite, and properties it doesn't send are kept. Off: OpenMetadata only fills in fields that are still empty, so manual edits in OpenMetadata are preserved. | | **Enable Debug Log** | Off | Run this ingestion at DEBUG log verbosity instead of the normal level. Turn on when troubleshooting a failing or unexpected run. Leave off otherwise, since debug logs are much larger. | > [!NOTE] > > Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures. ![Scope & Behaviour](https://mintcdn.com/openmetadata/oUGf8BeSz2Uo7tlL/public/images/connector2.0/metadata-ingestion/Database/database-scope-behaviour.png?fit=max\&auto=format\&n=oUGf8BeSz2Uo7tlL\&q=85\&s=03b790d0d7ce6a5f75f46002b06dcc05) * **Advanced Config**: Driver-level options (connection arguments, scheme, and timeouts). Most connections never need these, and they vary by connector. This section also has one ingestion-scope toggle: | Toggle | Default | Description | | - | - | - | | **Include Views** | On | Ingest views in addition to tables. Turn off to skip views entirely. Since view lineage is derived from parsing each view's SQL definition, turning this off also stops view-based lineage from being generated for this service. | ![Advanced Config](https://mintcdn.com/openmetadata/oUGf8BeSz2Uo7tlL/public/images/connector2.0/metadata-ingestion/Database/database-advance.png?fit=max\&auto=format\&n=oUGf8BeSz2Uo7tlL\&q=85\&s=70399f49ea960130062a9cd3c91a1840) 5. On the **Schedule Interval** page, set when the agent runs: * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression. * **On-Demand**: No automatic schedule; trigger the agent manually when needed. ![Schedule Interval](https://mintcdn.com/openmetadata/j50Bw6ZBiFbbFFnF/public/images/connectors/schedule.png?fit=max\&auto=format\&n=j50Bw6ZBiFbbFFnF\&q=85\&s=24b0c2f55f803efde5fb3b3bc24ed3ae) 6. Click **Add** to deploy the agent. ## Related > **[Usage Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/ingestion/workflows/usage.md)** > > Learn more about how to configure the Usage Workflow to ingest Query information from the UI. > **[Lineage Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/ingestion/workflows/lineage.md)** > > Learn more about how to configure the Lineage from the UI. > **[Profiler Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow.md)** > > Learn more about how to configure the Data Profiler from the UI. > **[Data Quality Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/configure.md)** > > Learn more about how to configure the Data Quality tests from the UI. > **[dbt Integration](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/database/dbt.md)** > > Learn more about how to ingest dbt models' definitions and their lineage. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.