Skip to main content

Quick Start Guide

Scale database reads globally in a few minutes.#

1. Create An account#

Signup and create a free PolyScale account here.

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 connection strings to use:

1. The PolyScale host address e.g. mysql.polyscale.global for MySQL databases.

2. A PolyScale provided database username.

These credentials can can be found within the Settings tab for each cache created in step 2 above.

PolyScale Database Username#

The username to be used for all database connections via PolyScale is a concatenation of a unique username provided by Polyscale and your current database username separated by a hyphen.

Example#

If the username provided by PolyScale was abc and the origin database username was foobar, the username to connect via PolyScale would be abc-foobar.

Connection credentialsObtaining your PolyScale connection details


info

PolyScale does not save your database username and password. To connect to your database via PolyScale, no database credentials on the origin database change. Simply update the database username and host with those provided from the cache Settings tab.

4. Configure Cache#

Any executed queries will be listed within the Observability tab of a cache. Using the provided visualisations, select the queries of interest to return all query results.

To create a new cache configuration, select a query and from the drop down menu, select Configure Cache. Here you can define how long to cache this query for. Read more about Cache Configuration.

Cache ConfigurationClick the Configure Cache option for any query