# PostgreSQL

Integrate, catalog, and govern PostgreSQL assets in Atlan

## Required permissions

- [Preflight checks for PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/preflight-checks-for-postgresql/llms.txt): Run preflight checks before the PostgreSQL crawler to validate connectivity, permissions, and configuration - and decode failures that happen before any check runs.

## Setup options

- [Set up PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/set-up-postgresql/llms.txt): :::warning Who can do this? You will probably need your PostgreSQL administrator to run these commands - you may not have access yourself.
- [Choose how Atlan connects to PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/choose-how-atlan-connects-to-postgresql/llms.txt): Compare the three ways Atlan can reach your PostgreSQL database - internet with IP allowlisting, private connectivity, or a self-deployed agent - and pick the right one before touching any firewall.
- [Connect over the internet with IP allowlisting](https://docs.atlan.com/llms/connectors/postgresql/connect-over-the-internet-with-ip-allowlisting/llms.txt): The fastest path to connect Atlan to PostgreSQL - Atlan connects to your database's public endpoint over TLS, and you allowlist Atlan's fixed egress IPs. Five phases, each labeled with who performs it.
- [Set up AWS PrivateLink to PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/set-up-a-private-network-link-to-postgresql/llms.txt): Connect Atlan to a private RDS or Aurora PostgreSQL database over AWS PrivateLink, so traffic never crosses the public internet. Five phases, each labeled with who performs it.
- [Set up Azure private connectivity to PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/set-up-azure-private-connectivity-to-postgresql/llms.txt): Private connectivity from Atlan to Azure Database for PostgreSQL is a support-assisted VNet peering setup - what to ask for, what you configure yourself, and the caveats to insist on before signing off.
- [Set up GCP private connectivity to PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/set-up-gcp-private-connectivity-to-postgresql/llms.txt): Private connectivity to PostgreSQL on Google Cloud depends on what the database is - Cloud SQL and AlloyDB have Private Service Connect paths under their own connectors; self-managed Postgres uses the self-deployed agent.
- [Special cases](https://docs.atlan.com/llms/connectors/postgresql/special-cases/llms.txt): On-premises PostgreSQL, many databases behind one PrivateLink, Aurora failovers and moving IPs, Azure and GCP hosting, cross-region IAM authentication, and VPC Lattice.

## Crawl and mine

- [Crawl PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/crawl-postgresql/llms.txt): Configure and run PostgreSQL metadata extraction workflows to catalog databases, schemas, tables, views, and columns in Atlan.
- [Mine PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/mine-postgresql/llms.txt): Once you have crawled assets from PostgreSQL, you can mine its query history to construct lineage.
- [Generate lineage](https://docs.atlan.com/llms/connectors/postgresql/generate-lineage-with-postgres-miner/llms.txt): Enable pg_stat_statements and configure your PostgreSQL instance so the PostgreSQL Miner workflow can extract query history and generate lineage.

## Reference

- [How Atlan connects to PostgreSQL](https://docs.atlan.com/llms/connectors/postgresql/how-atlan-connects-to-postgresql/llms.txt): Understand how Atlan securely connects to your PostgreSQL database to extract metadata, with support for multiple authentication methods and deployment modes
- [How database connectivity works](https://docs.atlan.com/llms/connectors/postgresql/how-database-connectivity-works/llms.txt): A plain-language explanation of the journey a connection makes from Atlan to your PostgreSQL database - the three gates it must pass, the three paths it can take, and SSL in one minute.
- [Firewalls, pg_hba.conf, and SSL](https://docs.atlan.com/llms/connectors/postgresql/firewalls-pg-hba-conf-and-ssl/llms.txt): The reference for gates 1 and 2 - what to allowlist where, how pg_hba.conf decides, and how to keep the SSL settings on both ends consistent. Applies to every connectivity method.
- [What does Atlan crawl from PostgreSQL?](https://docs.atlan.com/llms/connectors/postgresql/what-does-atlan-crawl-from-postgresql/llms.txt): During a PostgreSQL crawl, Atlan extracts metadata for Databases, Schemas, Tables, Views, and Functions. Reference tables map each PostgreSQL property to its Atlan asset.
- [Postgres assets package](https://docs.atlan.com/llms/connectors/postgresql/package-reference/llms.txt): Programmatically crawl and manage PostgreSQL assets in Atlan using the Python SDK (pyatlan). Reference for the PostgreSQL assets package.
- [PostgreSQL assets app](https://docs.atlan.com/llms/connectors/postgresql/postgresql-sdk-references-app-reference/llms.txt): Learn how to crawl PostgreSQL assets and publish them to Atlan for discovery.
- [PostgreSQL miner app](https://docs.atlan.com/llms/connectors/postgresql/postgresql-sdk-references-app-miner-reference/llms.txt): Learn how to mine query history from PostgreSQL to generate lineage and usage metrics.

## Troubleshooting

- [Troubleshooting PostgreSQL connectivity](https://docs.atlan.com/llms/connectors/postgresql/troubleshooting-postgresql-connectivity/llms.txt): Symptom-first troubleshooting for PostgreSQL connectivity - SSL and pg_hba rejections, timeouts, IAM authentication, wrong PrivateLink hostname, misleading error wrappers, and miner preflight failures.