> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Ingest Metadata

> Learn how to connect a data source and run metadata ingestion in Collate — a generic, connector-agnostic walkthrough.

# Ingest Metadata

Collate supports metadata ingestion from third-party sources through the UI. Admin users can connect to multiple service types — Databases, Dashboards, Pipelines, ML Models, Messaging, Storage, Search, and Metadata services — and schedule metadata ingestion at any frequency.

<Note>
  **Note**: You must have **Admin** access in Collate to add a connector and ingest metadata.
</Note>

The steps below apply to all service types. For connection details specific to your source, see the [Connectors](/ai-2-0/connectors) documentation.

## Step 1: Add a New Service

1. In the left navigation, click **Connections**.
2. On the **Connections** page, click **Add New Service**.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=733cef1141ef13d318634aa9f407eb2b" alt="Add New Service" width="2992" height="1256" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png" />

## Step 2: Select a Service Type and Connector

In the dropdown, select a service type that matches your data source, and then choose a connector.

Collate supports the following service types:

<Tabs>
  <Tab title="Database">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/database-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=bd212b7bb645345cec1965194d43acd2" alt="Database Services" width="2910" height="1536" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/database-service.png" />
  </Tab>

  <Tab title="Dashboard">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/dashboard-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=2ca819542566359a2438d7d172a0c98b" alt="Dashboard Services" width="2838" height="1522" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/dashboard-service.png" />
  </Tab>

  <Tab title="Pipeline">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/pipeline-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=3f8b56d56b77309d6eb9645bdf490b40" alt="Pipeline Services" width="2896" height="1570" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/pipeline-service.png" />
  </Tab>

  <Tab title="Messaging">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/messaging-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=b0e7d3edb142942f1cc91a04ddcd2a47" alt="Messaging Services" width="2982" height="1256" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/messaging-service.png" />
  </Tab>

  <Tab title="ML Model">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/mlmodel-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=8bb86a36b1c5c876d58cdaa3f19fbe90" alt="ML Model Services" width="2950" height="1216" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/mlmodel-service.png" />
  </Tab>

  <Tab title="Storage">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/storage-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=294333056677ae4714f6e4c5a1ad84d2" alt="Storage Services" width="2946" height="1346" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/storage-service.png" />
  </Tab>

  <Tab title="Search">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/search-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=d747af06281908d264d8148eda20294a" alt="Search Services" width="2952" height="1280" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/search-service.png" />
  </Tab>

  <Tab title="Metadata">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/metadata-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=ea58494283f6963b716be8197881dbc2" alt="Metadata Services" width="2942" height="1098" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/metadata-service.png" />
  </Tab>

  <Tab title="API">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/api-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=3663a45cb533c07d4ba01bf74a91b97b" alt="API Services" width="2950" height="1210" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/api-service.png" />
  </Tab>

  <Tab title="Drive">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/drive-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=f6965effbe5f26ac40fbfd66a84e894f" alt="Drive Services" width="2954" height="1346" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/drive-service.png" />
  </Tab>

  <Tab title="Security">
    <img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/security-service.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=985f06abdcde0aa630d1e42ba33a02eb" alt="Security Services" width="2966" height="1244" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/security-service.png" />
  </Tab>
</Tabs>

For the full list of available connectors, see [Connectors](/ai-2-0/connectors).

## Step 3: Add a Service Name and Description

* Enter a unique, descriptive **Service Name**. Collate identifies services by their service name — choose a name that distinguishes this service from others of the same type.
* (Optional) Enter a **Description** to document the service and help other users understand what it contains.

<img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/service-name.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=ce5687ddb3e61520d2d9d762c182c8b9" alt="Service Name" width="1844" height="646" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/service-name.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

## Step 4: Configure Connection Options

### Select Ingestion Runner

Select an **Ingestion Runner** — the environment where the ingestion pipeline will execute.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=1249f828648614445e8a976ea1933487" alt="Select Ingestion Runner" width="1444" height="506" data-path="public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png" />

### Enter Connection Details

Enter the connection credentials for your source. The required fields differ by connector — refer to the connector-specific documentation in the [Connectors](/ai-2-0/connectors) section for the full list of fields and accepted values.

The right-hand panel in the Collate UI displays inline help for each field as you fill in the form.

### Test Connection

Once credentials are entered, click **Test Connection** to verify access before saving. The test checks connectivity and confirms which data assets can be ingested using the provided credentials.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=3365cff7bb9d82c85a2ff9ab559d6f11" alt="Test Connection" width="1446" height="188" data-path="public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png" />

After the connection test passes, click **Save**.

## Step 5: Configure What to Ingest

Use filter patterns to control which assets Collate ingests from the service.

**How filter patterns work:**

* **Include** — Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude** — Add one or more comma-separated regular expressions. Collate skips any asset whose name matches at least one expression. Leave blank to exclude nothing.

When both Include and Exclude are set, Exclude takes priority.

Rules match asset names using one of the following expressions:

* **contains** — matches any name containing the value.
* **starts with** — matches names beginning with the value.
* **ends with** — matches names ending with the value.
* **is exactly** — matches the exact name only.
* **matches regex** — matches names using a full regular expression.

<Tip>
  **Tip**: Leave all filter patterns empty to ingest all assets available in the source.
</Tip>

## Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source.

To monitor progress or view the service you just added, go to **Connections** in the left navigation and select your service.

## Configure and Schedule the Metadata Agent

After the service is created, you can configure the metadata agent and set an ingestion schedule.

1. Go to the **Agents** tab on the service page and click **Add Metadata Agent**.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=accad7d1c4ddf209781bff851d51d464" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png" />

2. Enter a name for the agent. The name is pre-populated with the service name and a suffix to ensure uniqueness.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=d5ec1f0f3742cadab8cd54c602c97239" alt="Metadata Agent Name" width="1578" height="644" data-path="public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png" />

3. Define when the agent runs. Select a preset schedule or enter a **Custom Cron** expression.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/schedule.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=25cc1d78f6f2a8bd115830d034d1d8d1" alt="Schedule Metadata Agent" width="1588" height="1044" data-path="public/images/ai-2.0/connectors/metadata-ingestion/schedule.png" />

4. Click **Create & Deploy** to save the schedule and start the agent.

## View and Manage Agent

After deployment, go to the **Agents** tab on the service page.

* The **Metadata Agents** section lists each deployed agent with its status badge (**Success**, **Failed**, **Running**, and so on), asset count, and the time it last ran.
* Click **View run history** under an agent to see a full log of past runs.
* To manage an agent, use the action buttons on each agent row:
  * **Logs** — View the pipeline logs for the most recent run.
  * **Run** — Trigger the pipeline immediately.
  * **⋮ menu** —      - **Pause** — Pause the scheduled pipeline without deleting it.
    * **Re-deploy** — Re-apply updated credentials or configuration and re-ingest data. Use this when source credentials change after the initial setup.
    * **Edit configuration** — Modify the agent's filter patterns, schedule, or settings.
    * **Delete agent** — Permanently remove the agent.

<img src="https://mintcdn.com/collatedocs/bKBGXz6FBahnppp1/public/images/ai-2.0/admin-guide/metadata-ingestion/view-manage-Agent.png?fit=max&auto=format&n=bKBGXz6FBahnppp1&q=85&s=0941c687c2561f3ad7e23fa9b522b3e4" alt="View and Manage Agent" width="2834" height="1378" data-path="public/images/ai-2.0/admin-guide/metadata-ingestion/view-manage-Agent.png" />

## Browsing Ingested Data

After ingestion completes, open the service page and go to the relevant asset tab — for example, **Databases** for a database service. From there, drill down to view schemas, tables, and columns.

<Tip>
  **Tip**: After running a metadata agent pipeline, you can add separate pipelines for [**Usage**](/ai-2-0/how-to-guides/guide-for-data-users/ingestion/workflows/usage), [**Lineage**](/ai-2-0/how-to-guides/guide-for-data-users/ingestion/workflows/lineage), [**dbt**](/ai-2-0/connectors/database/dbt), and [**Profiler**](/ai-2-0/how-to-guides/data-quality-observability/profiler/profiler-workflow). Go to the **Agents** tab, select the required agent type, and enter the details.
</Tip>

## Managing Services

Admin users can create, edit, or delete services, and view connection details for existing services from the **Connections** page.

<CardGroup cols={2}>
  <Card title="Connectors" href="/ai-2-0/connectors">
    Browse all supported connectors and connector-specific setup guides.
  </Card>

  <Card title="Delete a Service Connection" href="/ai-2-0/admin-guide/delete-service-connection">
    Permanently delete a service connection and its associated agents.
  </Card>
</CardGroup>
