​
1. Install the Quill SDK

If you haven’t already, start by installing the Quill Server SDK on your machine:

npm install @quillsql/node

​
2. Create a cache config

To get started with the Quill data cache, you can either bring your own cache or use our built-in cache in Quill Cloud. If you bring your own cache, you’ll need the connection info such as username, password, host, and port.

A typical redis connection string with all of the parts might look something like this: redis://quill_username:secret_password@example.com:12345

Using Quill Cloud is the easiest way to get started with Quill. Reach out to our team and ask about the Quill data cache to get started.

Make sure to add the Quill server to your database IP whitelist, if you have one. Requests from Quill will always come from 34.133.137.225

​
3. Pass cache to Quill SDK

import { Quill } from "@quillsql/node";

const quill = new Quill({
	privateKey: process.env.QULL_PRIVATE_KEY,
	databaseConnectionString: process.env.POSTGRES_READ,
	databaseType: "postgresql",
	// Just pass a cache config to the Quill instance:
	cache: {
		username: process.env.REDIS_USERNAME,
		password: process.env.REDIS_PASSWORD,
		host: process.env.REDIS_HOST,
		port: process.env.REDIS_PORT,
		cacheType: "redis", // or 'rediss' if SSL encrypted
	},
});

Then you’re done! When Quill detects a valid cache configuration it will start using the cache provided to speed up frequently used queries.