Skip to main content

Integrating Momento with your Sequelize backed database

Sequelize is a popular ORM for Oracle, Postgres, MySQL, MariaDB, SQLite and SQL Server, and more.

In this tutorial, we'll walk through our Momento sequelize model cache wrapper. By the end of the exercise, you'll be able to seamlessly cache your sequelize-backed ORM databases with minimal code changes.

Prerequisites​

To use Momento with Sequelize in your app, you'll need to have the following available:

  • Node version 16 and above installed on your machine https://nodejs.org/en/download
  • Configure the Momento side of things using the Momento console. You can create an account in the console by providing your email address or linking an existing Google or GitHub account. Once you've logged into the console, click the Create Cache button on the top right of the page:

Create Cache button

Create a cache called model-cache. You can create the cache in your choice of cloud provider, AWS or GCP, and in any region.

Create cache form

After pressing the Create button you'll see the new model-cache cache in the list of available caches.

Notice the region you created your cache in is also displayed in the list of caches. You'll need to make sure that you choose the same region when you generate a Momento authentication token in the next step. Navigate to the api_keys page, choose the cloud provider and region you used to create your cache, choose the Super User API Key key type, and hit the Generate API Key button.

Generate token

Copy the API Key and save it in a safe place. You'll need to use it later to run your application, where you will add it as an environment variable.

Generated token

Integrating the wrapper in your application​

To integrate the Momento wrapper in your sequelize-backed application, let's first install the latest release of the wrapper.

npm install @gomomento-poc/momento-sequelize-cache

Now you're ready to add the necessary imports and wrap your Sequelize models such that it will be backed by Momento as a read-aside cache. Creating a Momento wrapper over your Sequelize backed database simply involves creating a Momento client and passing it to a factory method. Remember to export your copied ApiKey as an environment variable MOMENTO_API_KEY.

import { Configurations, CredentialProvider } from "@gomomento/sdk";
import { modelCacheFactory, MomentoClientGenerator} from "@gomomento-poc/momento-sequelize-cache";

const momentoClient = MomentoClientGenerator.getInstance({
        configuration: Configurations.Laptop.latest(),
        credentialProvider: CredentialProvider.fromEnvironmentVariable({environmentVariableName: 'MOMENTO_API_KEY'}),
        defaultTtlSeconds: 60,    
});

const modelCache = await modelCacheFactory(momentoClient);

The modelCache object provides a wrap method that you can use to wrap any existing Sequelize model. From that point, the wrapped object provides the same familiar APIs that your Sequelize model object would. For example, to fetch a User (from a User model) by the primary key, the call looks like:

await modelCache.wrap(User).findByPk(1);

This call orchestrates the read-aside caching lifecycle: prioritizing cache retrieval, resorting to the Sequelize database on cache misses, and subsequently updating the cache for future requests. You can quickly get started by running one of our examples with various queries.

Examples​

Ready to jump in and explore more functionalities? You can also get started with our examples by forking the repo and running the example:

git clone https://github.com/momentohq/momento-sequelize-cache
cd examples
npm install
MOMENTO_API_KEY="yourApiKey" npm run basic

This example demonstrates various Sequelize operations supported by the wrapper such as findByPk, findOne, count, and findAll. It also demonstrates joins between different tables whose queries can be cached.

Conclusion​

A read-aside cache can significantly improve the performance of applications. It not only accelerates data retrieval but also lightens the load on primary data stores, resulting in benefits for both developers and end-users. With Momento enhancing your Sequelize applications, you're set to experience a harmonious blend of speed and efficiency.