Back to Documentation

Getting Started

Connect your first database and discover relationships in under 60 seconds.

1

Create an Account

Sign up at app.squishdata.com with your email address. No credit card required -- Squish is free during beta.

2

Add a Connection

Navigate to Connections and click "Add Connection". Select your database type, enter the host, port, database name, and read-only credentials. Click "Test Connection" to verify access before saving.

3

Run Discovery

Go to the Discovery page, select your connection, and click "Start Discovery". Squish analyzes your schema using multiple methods: foreign key detection, naming conventions, and statistical analysis. Progress updates in real-time via WebSocket.

4

View Results

Once discovery completes, view your results in the relationships table or the interactive ERD visualization. Each relationship shows a confidence score based on the detection methods that found it.

Alternative: Upload Schema

If you cannot provide live database access -- due to compliance restrictions, air-gapped environments, or security policy -- you can upload your schema as a CSV or DDL file instead.

Export your schema as a CSV with these required columns:

Required columns
table_name,column_name,data_type
users,id,integer
users,email,varchar
users,created_at,timestamp
orders,id,integer
orders,user_id,integer
orders,total,decimal
orders,status,varchar

Optional columns: is_nullable, column_default, character_maximum_length

Schema upload uses naming convention and column name analysis to discover relationships. For statistical analysis (cardinality matching), connect directly to your database.

Next Steps

Ready to get started?

Open Squish App