From 1dcd00f43dd5f68261b531cd5ff286778796dc8f Mon Sep 17 00:00:00 2001 From: Chris Munns Date: Wed, 27 May 2026 11:53:42 -0400 Subject: [PATCH] Bring Neon and MySQL to parity across all docs Picks up the missing provider/engine mentions surfaced by an audit of every .md file in the repo after the 1.2.0 release: - README.md: mention MySQL/Vitess in the overview - docs/performance_considerations.md: include Heroku Postgres + Neon in the managed-services list - docs/providers/README.md: add neon install line, neon to the JSON output example, drop the stale (now-incomplete) Provider Comparison table - sql_discovery/README.md: add Supabase and Neon to the managed PG services the standalone SQL script supports - docs/troubleshooting.md: broaden the managed-services list to match - docs/providers/aws.md: note PostgreSQL and MySQL engines in the Aurora/RDS overview line - docs/providers/gcp.md: note PostgreSQL and MySQL engines in the Cloud SQL overview line - docs/mysql.md: callout clarifying that AWS and GCP cloud analyzers cover MySQL, but the Supabase/Heroku/Neon providers are Postgres-only --- README.md | 2 +- docs/mysql.md | 2 ++ docs/performance_considerations.md | 2 +- docs/providers/README.md | 17 +++++------------ docs/providers/aws.md | 2 +- docs/providers/gcp.md | 2 +- docs/troubleshooting.md | 2 +- sql_discovery/README.md | 2 ++ 8 files changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 15416ce..1e70d13 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # PlanetScale Discovery Tools -Discovery tools for analyzing database environments and cloud infrastructure. These tools provide a complete picture of your source environment including database configuration, schema structure, performance characteristics, and cloud infrastructure topology. +Discovery tools for analyzing PostgreSQL and MySQL/Vitess database environments and cloud infrastructure. These tools provide a complete picture of your source environment including database configuration, schema structure, performance characteristics, and cloud infrastructure topology. ## Overview diff --git a/docs/mysql.md b/docs/mysql.md index 6bbce3c..25b4efa 100644 --- a/docs/mysql.md +++ b/docs/mysql.md @@ -4,6 +4,8 @@ The PlanetScale Discovery CLI can analyze MySQL and MySQL-compatible databases including standard MySQL, MariaDB, Percona Server, Amazon Aurora MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, and PlanetScale (Vitess). The tool collects metadata about database configuration, schema structure, performance characteristics, replication topology, and feature usage without accessing actual table data. +> **Cloud provider support:** MySQL discovery is supported on AWS RDS MySQL, Aurora MySQL, and GCP Cloud SQL MySQL — both cloud analyzers recognize the MySQL engine and report it accordingly. The Supabase, Heroku Postgres, and Neon providers in this repo are PostgreSQL-only. + ## Prerequisites - MySQL-compatible database server (MySQL 5.7+, MySQL 8.0+, MariaDB 10.x, or compatible) diff --git a/docs/performance_considerations.md b/docs/performance_considerations.md index 16f015f..8022978 100644 --- a/docs/performance_considerations.md +++ b/docs/performance_considerations.md @@ -247,7 +247,7 @@ database: ### Managed Database Environments -When running against managed PostgreSQL services (AWS RDS, Cloud SQL, Supabase, etc.): +When running against managed PostgreSQL services (AWS RDS, Cloud SQL, Supabase, Heroku Postgres, Neon, etc.): - **Default analyzers are safe** - they only read metadata - **Data size analyzer requires caution** - consult your cloud provider's best practices diff --git a/docs/providers/README.md b/docs/providers/README.md index b420324..10cee9a 100644 --- a/docs/providers/README.md +++ b/docs/providers/README.md @@ -242,6 +242,9 @@ pipx install -e ".[heroku]" # All providers pipx install -e ".[all]" + +# Neon only +pipx install -e ".[neon]" ``` ## Output Format @@ -255,7 +258,8 @@ All providers generate consistent output: "aws": { /* AWS discoveries */ }, "gcp": { /* GCP discoveries */ }, "supabase": { /* Supabase discoveries */ }, - "heroku": { /* Heroku discoveries */ } + "heroku": { /* Heroku discoveries */ }, + "neon": { /* Neon discoveries */ } }, "summary": { "providers_discovered": ["aws", "gcp", "supabase", "heroku"], @@ -325,17 +329,6 @@ All providers generate consistent output: 3. Review logs for warnings about skipped resources 4. Ensure API endpoints are accessible -## Provider Comparison - -| Feature | AWS | GCP | Supabase | Heroku | -|---------|-----|-----|----------|--------| -| Database Types | RDS, Aurora | Cloud SQL, AlloyDB | PostgreSQL | PostgreSQL (add-ons) | -| Authentication | IAM, Access Keys | Service Accounts | Access Tokens | API Keys | -| Networking | VPC, Security Groups | VPC, Firewalls | SSL, IPv6 | Managed (no VPC config) | -| Pricing Tiers | Multiple | Multiple | Free to Enterprise | Essential to Shield | -| API Maturity | Mature | Mature | Growing | Mature | -| Documentation | Extensive | Extensive | Good | Good | - ## Getting Help - [Main README](../../README.md) diff --git a/docs/providers/aws.md b/docs/providers/aws.md index ab04199..f192c61 100644 --- a/docs/providers/aws.md +++ b/docs/providers/aws.md @@ -2,7 +2,7 @@ ## Overview -The PlanetScale Discovery CLI can analyze AWS RDS instances, Aurora clusters, and related networking infrastructure. +The PlanetScale Discovery CLI can analyze AWS RDS instances, Aurora clusters (both PostgreSQL and MySQL engines), and related networking infrastructure. ## Prerequisites diff --git a/docs/providers/gcp.md b/docs/providers/gcp.md index 37633ee..1661103 100644 --- a/docs/providers/gcp.md +++ b/docs/providers/gcp.md @@ -2,7 +2,7 @@ ## Overview -The PlanetScale Discovery CLI can analyze Google Cloud SQL instances, AlloyDB clusters, and related networking infrastructure. +The PlanetScale Discovery CLI can analyze Google Cloud SQL instances (PostgreSQL and MySQL engines), AlloyDB clusters, and related networking infrastructure. ## Prerequisites diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index f002532..3edf383 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -100,7 +100,7 @@ pip install psycopg2-binary ## Managed Database Environments -When running against managed PostgreSQL services (AWS RDS, Google Cloud SQL, etc.): +When running against managed PostgreSQL services (AWS RDS/Aurora, GCP Cloud SQL/AlloyDB, Supabase, Heroku Postgres, Neon, etc.): - **Expected Warnings**: You may see warnings about missing schema privileges or transaction errors for certain advanced features - **Graceful Degradation**: The tool is designed to continue analysis even when some features are restricted diff --git a/sql_discovery/README.md b/sql_discovery/README.md index 36b2afc..8c68f83 100644 --- a/sql_discovery/README.md +++ b/sql_discovery/README.md @@ -59,7 +59,9 @@ This script works with managed PostgreSQL services: - **AWS RDS/Aurora PostgreSQL**: Works with standard RDS permissions - **GCP Cloud SQL/AlloyDB**: Works with standard CloudSQL permissions - **Azure Database for PostgreSQL**: Works with standard Azure permissions +- **Supabase**: Works with the `postgres` superuser - **Heroku Postgres**: Works with standard Heroku permissions +- **Neon**: Works with the project's default `neondb_owner` role - **Self-hosted PostgreSQL**: Works with any user that has database read access Some replication and advanced statistics views may not be accessible on managed services - the script handles this gracefully.