Preflight checks for Cloud SQL for PostgreSQL

✦TL;DR

Verify prerequisites before setting up the Cloud SQL for PostgreSQL connector

||

Your AI can read this via Docs MCPcurl -fsSL "https://docs.atlan.com/install-docs-mcp" | bashConnect

In case of 'Direct' extraction method, before running the Cloud SQL for PostgreSQL crawler, you can run preflight checks to perform the necessary technical validations. The following preflight check is completed:

Database and schema check

✅ Check successful

❌ Check failed for $missingObjectName

Tables check

✅ Check successful. Table count: <count>

❌ Check failed. Missing some of the required grants SELECT, SHOW VIEW, EXECUTE on tables:

Miner

Did you know?

Once you have crawled assets from Cloud SQL for PostgreSQL, you can mine query history to construct lineage. The miner reads pg_stat_statements directly.

The miner runs its own preflight checks, in this order. A failed blocking check stops the checks after it.

Authentication

Verifies the miner can connect to the instance with the selected connection's credential. This check is blocking.

✅ Connected to the instance

❌ The message describes the connection error, for example an IP type the instance doesn't have.

Query history access

Verifies pg_stat_statements is installed and readable by the connection role. This check is blocking.

✅ pg_stat_statements is installed and readable (<n> extractable, <n> masked)

❌ pg_stat_statements is not available on this instance. Enable the cloudsql.enable_pg_stat_statements database flag on the Cloud SQL instance, then re-run preflight.

❌ pg_stat_statements is not installed on this database. Run CREATE EXTENSION pg_stat_statements; in the database you crawl, using a role allowed to create extensions. If the extension isn't offered at all, enable the cloudsql.enable_pg_stat_statements database flag on the instance first.

❌ pg_stat_statements is installed but not readable by this user. Grant the connection role pg_read_all_stats, then re-run preflight.

❌ Could not verify pg_stat_statements for query history. or Could not verify pg_stat_statements on the source. Check that pg_stat_statements is enabled on the Cloud SQL instance and that the connection role can read it.

All three setup steps are covered in Mine Cloud SQL for PostgreSQL.

Server version

Reports the PostgreSQL server version. This check is advisory and doesn't block the run. The miner adjusts to the pg_stat_statements timing columns that PostgreSQL 13 renamed.

✅ PostgreSQL server version <version>

✅ PostgreSQL server version could not be determined (advisory, the run continues)