Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/performance_considerations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 5 additions & 12 deletions docs/providers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,9 @@ pipx install -e ".[heroku]"

# All providers
pipx install -e ".[all]"

# Neon only
pipx install -e ".[neon]"
```

## Output Format
Expand All @@ -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"],
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/providers/gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions sql_discovery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading