Skip to main content

Quick Start Guide

PolyScale can be integrated with your current database simply by updating the database connection string.

1. Create An account

Signup and create a free PolyScale account here. There is a free tier and no credit card is required.

2. Create A Cache

A Polyscale account can have one or more caches defined. A cache simply identifies a database origin via a hostname and port that you wish to cache data for. Typically you create a cache per database for simplicity.

To create a new cache, click the New Cache button in the upper right of the caches dashboard and enter the hostname and port of the database you wish to connect to.

New cache buttonClick the New Cache button
Create new CacheEnter the origin database hostname and port

3. Connect Client Apps

To connect to the origin database via PolyScale simply update any client applications as follows:

1. Use a PolyScale database hostname and port:



  • MySQL: 3306
  • MariaDB: 3307
  • PostgreSQL 5432
  • SQL Server 1433
  • MongoDB 27017

2. Provide a PolyScale Cache ID as part of the connection string:

The Cache ID can be found under the Settings tab of any cache (as detailed in Step 2 above). For MySQL, MariaDB and SQL Server, this is prepended to the database username seperated with a hyphen (see example below). For PostgreSQL, an application_name property containing the PolyScale Cache ID is required as part of the connection string e.g. application_name=MY_CACHE_ID.

For further details, see Getting Connected.

MySQL Example

If the cache ID provided by PolyScale is 8794d0be-4cbf-4ac2-b230-28e524782405 and the origin database username is foobar, the database username to connect via PolyScale would be 8794d0be-4cbf-4ac2-b230-28e524782405-foobar.

Connection credentialsObtaining your PolyScale connection details for MySQL


PolyScale does not save your database username and password. To connect to your database via PolyScale, no database credentials on the origin database change.

4. Cache Automation

Once queries are passing through PolyScale, switch to the Observability tab to view the traffic and cache behavior.

As default, PolyScale will automatically manage the caching of all queries that pass through the platform. That means you can simply connect to PolyScale and queries will begin to be cached.

Keep in mind that the cache will require some period of warming before queries are cached. PolyScale's machine learning algorithms identify caching opportunities by recognizing and remembering patterns in query traffic. For new queries, you will typically begin to see cache hits on or about the third query. (You can read more about Time To First Hit here.)

Read more about Cache Configuration.

Cache ObservabilityDefault observability view.