Onboarding to Readyset QueryPilot (Beta)
This guide walks through the process of setting up a QueryPilot cluster on ReadySet Cloud.
Create a Cluster
To get started, navigate to the Create Cluster screen in your ReadySet Cloud dashboard. You can either:
- Spin up a Demo Cluster for quick testing
- Or configure your own fully managed or self-hosted cluster
Cluster Details
- Cluster Name: A descriptive label like
prodorstaging - Region: Should match the region of your source database (e.g.,
us-east-2) - Isolation Mode: Deploy in your own AWS account (
Yes) or let ReadySet host it (No) - Private Connectivity: Optional VPC peering for private databases — Learn more
Choose a Cluster Type
Select:
QueryPilot Extra Small: 2 GB cache, 5 GB disk, 5 MB/s — Free (2-month trial)
⚠️ Note: The Free tier is limited to databases under 5 GB and fewer than 10 tables.
Database Connectivity
You can either enter a connection string or manually input host credentials.
Option 1: Use a Connection String
mysql://username:password@host:port/database
Make sure to URL-encode special characters such as
@→%40.
Option 2: Enter Credentials Manually
- Database: MySQL
- Username / Password / Host
- Database Name and Port
Replication Access (Optional)
If your primary credentials don’t support replication, provide a second set specifically for CDC (Change Data Capture) to ensure real-time cache updates.
Configure QueryPilot
- Number of Queries: Max number of queries QueryPilot will cache (e.g.,
10) - Shallow Cache TTL: In milliseconds (e.g.,
10000 = 10 seconds)
These settings define how aggressively QueryPilot caches your most active queries.
Advanced Features
The final page allows the configuration of advanced ReadySet Cloud features. These options enable fine-tuned control over replication, caching, encryption, query monitoring, and data-flow behavior.
ℹ️ Note: Depending on the feature set enabled for your organization, some options may be hidden from the UI. If you need access to a setting that isn’t visible, please reach out to ReadySet support.
In most cases, the default settings should be left unchanged unless you have been instructed by ReadySet support to enable specific features.
Once your configuration is complete, click Create cluster to provision the cluster with the selected options.
