> ## 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.

# Search Connectors

> Learn how search connectors work, enabling full-text indexing and discovery across all ingested metadata.

# Search Services

This is the supported list of connectors for Search Services:

<CardGroup cols="2">
  <Card title="Elasticsearch" icon="https://mintcdn.com/collatedocs/NU2cty4wnF-KyKEi/public/images/connectors/elasticsearch.webp?fit=max&auto=format&n=NU2cty4wnF-KyKEi&q=85&s=9991e2f3134abad9436ff634f80872dd" href="/ai-2-0/connectors/search/elasticsearch" horizontal width="512" height="512" data-path="public/images/connectors/elasticsearch.webp">
    <img src="https://mintcdn.com/collatedocs/qTqd1tlB8cqEVgXb/public/images/connectors/openmetadata-logo.png?fit=max&auto=format&n=qTqd1tlB8cqEVgXb&q=85&s=ad28bd1f2fd6ae2dd39f0703121c1653" style={{ position: 'absolute', top: '17px', right: '60px', width: 'auto', height: '16px', margin: '0' }} alt="OpenMetadata" width="69" height="83" data-path="public/images/connectors/openmetadata-logo.png" />

    <div className="prod-beta-chip prod">PROD</div>
  </Card>

  <Card title="OpenSearch" icon="https://mintcdn.com/collatedocs/zC_mCmaFzPIaL_6m/public/images/connectors/opensearch.webp?fit=max&auto=format&n=zC_mCmaFzPIaL_6m&q=85&s=e668a2e7a450fa8083f3692b0391e411" href="/ai-2-0/connectors/search/opensearch" horizontal width="512" height="512" data-path="public/images/connectors/opensearch.webp">
    <img src="https://mintcdn.com/collatedocs/qTqd1tlB8cqEVgXb/public/images/connectors/openmetadata-logo.png?fit=max&auto=format&n=qTqd1tlB8cqEVgXb&q=85&s=ad28bd1f2fd6ae2dd39f0703121c1653" style={{ position: 'absolute', top: '17px', right: '60px', width: 'auto', height: '16px', margin: '0' }} alt="OpenMetadata" width="69" height="83" data-path="public/images/connectors/openmetadata-logo.png" />

    <div className="prod-beta-chip beta">BETA</div>
  </Card>
</CardGroup>

If you have a request for a new connector, reach out in [Slack](https://slack.open-metadata.org/) or
open a [feature request](https://github.com/open-metadata/OpenMetadata/issues/new/choose) in our GitHub repo.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts search indexes, mappings, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, Collate 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. In the left navigation, click **Connections** and select your service.

2. Click the **Agents** tab.

3. Click **Add Agent** and select **Metadata** from the dropdown.
   <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" />
   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.

     <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="Name this Ingestion" width="1578" height="644" data-path="public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure the core parameters for this agent. The following fields are available:

     | Field                       | Default | Description                                                                                                                     |
     | --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
     | Sample Size                 | 10      | Number of records to fetch as sample data per search index.                                                                     |
     | Mark Deleted Search Indexes | On      | Soft-delete search indexes in Collate when they are removed from the source. Associated entities like lineage are also deleted. |
     | Include Sample Data         | On      | Fetch sample records from search indexes during ingestion.                                                                      |
     | Include Index Template      | Off     | Ingest index template metadata alongside search index mappings.                                                                 |

     <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/Search/search-agent-setup.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=6667c6625744c92ed0cdc4845d157cd5" alt="Agent Setup" width="1564" height="894" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Search/search-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which search indexes this agent ingests. These follow the same filter options described in **Step 5**.

     <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/Search/search-filter-pattern.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=fa2c489f7a2561ff4a731c9433b65236" alt="Filter Patterns" width="1560" height="378" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Search/search-filter-pattern.png" />

   * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     | Toggle            | Default | Description                                                                                                                                                            |
     | ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Enable Debug Log  | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                     |
     | Override Metadata | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value. |

     <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/Search/search-scope-behaviour.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=9871f3edeb7caef87150639d756aff53" alt="Scope & Behaviour" width="1562" height="578" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Search/search-scope-behaviour.png" />

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.

   <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 Interval" width="1588" height="1044" data-path="public/images/ai-2.0/connectors/metadata-ingestion/schedule.png" />

6. Click **Add** to deploy the agent.
