## Crawl on-premises databases

URL: https://docs.atlan.com/apps/connectors/database/on-premises-databases/how-tos/crawl-on-premises-databases

> Extract metadata from on-premises databases to catalog tables, schemas, and views. Discover and govern your database assets after configuring the metadata-extractor tool.

:::danger **Deprecated**
This job execution mode was deprecated on June 30, 2026 and is no longer supported or maintained, including bug fixes. Existing workflows may break/be disabled without warning. For all implementations, switch to [Self-deployed runtime](https://docs.atlan.com/llms/platform/self-deployed-runtime/llms.txt).
:::

Extract metadata from your [on-premises databases](https://docs.atlan.com/llms/connectors/on-premises-databases/set-up-on-premises-database-access/llms.txt) into Atlan to catalog tables, schemas, and views. After setting up the metadata-extractor tool, you can extract metadata from your databases using the following steps.

## Run metadata-extractor

### Crawl all databases

To crawl all databases using the metadata-extractor tool:

1. Log into the server with Docker Compose installed.
2. Change to the directory containing the compose file.
3. Run Docker Compose: `sudo docker-compose up`.

### Crawl specific database

To crawl a specific database using the metadata-extractor tool:

1. Log into the server with Docker Compose installed.
2. Change to the directory containing the compose file.
3. Save the compose file and use the command `sudo docker-compose up ` within the local folder where the compose file is stored.

(Replace `` with the name of the connection from the `services` section of the compose file.)

## (Optional) Review generated files

The metadata-extractor tool generates the following JSON files for each `service`:

- `columns-.json`
- `databases.json`
- `extras-procedures-.json`
- `procedures-.json`
- `schemas-.json`
- `table-.json`
- `view-.json`

You can inspect the metadata and make sure it's acceptable to provide the metadata to Atlan.

## Upload generated files to S3

To provide Atlan access to the extracted metadata, you need to upload the metadata to an S3 bucket.

:::info **Did you know?** 
To avoid access issues, upload to the same S3 bucket that Atlan uses. [Raise a support request](https://docs.atlan.com/support/submit-request) to get your Atlan bucket details, and include the ARN of the IAM user or IAM role so access can be provisioned. To create a separate bucket, see [Option 1: Use your own bucket](https://docs.atlan.com/llms/connectors/dbt/set-up-dbt-core/llms.txt) in the dbt documentation (the steps are the same).
:::

To upload the metadata to S3:

1. Confirm that all the files for a particular service have the same prefix. For example, `metadata/inventory/columns-inventory.json`, `metadata/inventory/databases.json`, etc.
2. [Upload the files to the S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html) using your preferred method.

For example, to upload all the files using the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html):

```
aws s3 cp output/inventory s3://my-bucket/metadata/inventory --recursive
```

## Crawl metadata in Atlan

Once you have extracted metadata on-premises and uploaded the results to S3, you can crawl the metadata into Atlan:

- [Amazon Redshift](https://docs.atlan.com/llms/connectors/amazon-redshift/crawl-amazon-redshift/llms.txt)
- [Hive](https://docs.atlan.com/llms/connectors/hive/crawl-hive/llms.txt)
- [Microsoft SQL Server](https://docs.atlan.com/llms/connectors/microsoft-sql-server/crawl-microsoft-sql-server/llms.txt)
- [MySQL](https://docs.atlan.com/llms/connectors/mysql/crawl-mysql/llms.txt)
- [Oracle](https://docs.atlan.com/llms/connectors/oracle/crawl-oracle/llms.txt)
- [PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/crawl-postgresql/llms.txt)
- [SAP HANA](https://docs.atlan.com/llms/connectors/sap-hana/crawl-sap-hana/llms.txt)
- [Snowflake](https://docs.atlan.com/llms/connectors/snowflake/crawl-snowflake/llms.txt)
- [Teradata](https://docs.atlan.com/llms/connectors/teradata/crawl-teradata/llms.txt)

For each of these connectors, select **Offline** for the extraction method.

## See also

- [Migrate from jdbc-metadata-extractor to Self-Deployed Runtime](https://docs.atlan.com/llms/catalog/connector-capabilities/migrate-jdbc-to-sdr/llms.txt)

---