Getting Started
First Connection
Connect to your first database in data-peek
First Connection
Let's connect data-peek to your database. This guide uses PostgreSQL, but the process is similar for MySQL.
Adding a Connection
- Click the + button in the sidebar under "Connections"
- Fill in your connection details:
| Field | Description | Example |
|---|---|---|
| Name | A friendly name for this connection | Local Dev |
| Host | Database server hostname or IP | localhost |
| Port | Database port | 5432 (PostgreSQL) or 3306 (MySQL) |
| Database | Database name | myapp_development |
| User | Database username | postgres |
| Password | Database password | •••••••• |
- Click Test Connection to verify your settings
- Click Save to add the connection
You can also paste a connection string directly. data-peek will auto-fill all fields from URLs like:
postgresql://user:password@localhost:5432/databaseConnection String Format
PostgreSQL
postgresql://[user]:[password]@[host]:[port]/[database]?sslmode=[mode]MySQL
mysql://[user]:[password]@[host]:[port]/[database]SSL/TLS Connections
For secure connections to cloud databases:
- Check the SSL option when adding your connection
- For services like Supabase, Railway, or Neon, SSL is usually required
Always use SSL when connecting to production databases over the internet.
Managing Connections
Editing a Connection
- Right-click the connection in the sidebar
- Select Edit
- Modify the details and save
Deleting a Connection
- Right-click the connection in the sidebar
- Select Delete
- Confirm the deletion
Switching Connections
- Click on any connection in the sidebar to switch to it
- Use
Cmd+P(macOS) orCtrl+P(Windows/Linux) to open the connection picker - Use
Cmd+Shift+1-9to quickly switch between connections 1-9
Connection Status
The connection indicator shows:
| Status | Meaning |
|---|---|
| 🟢 Green | Connected and ready |
| 🟡 Yellow | Connecting... |
| 🔴 Red | Connection error |
Next Steps
Now that you're connected, let's run your first query!