Database Options

Last updated: Nov 1, 2024 2 minutes read.

Introduction

Tyk Dashboard requires a persistent datastore for its operations. By default MongoDB is used. From Tyk v4.0, we also support PostgreSQL.

MongoDB Supported Versions and Drop-in Replacement

MongoDB is our default storage option. We support the following versions:

MongoDB 5.0.x, 6.0.x, 7.0.x (with mongo-go driver).

Note: mongo-go driver has been available since Tyk 5.0.2 and is the default from Tyk 5.3.0.

MongoDB 3.x to 4.4.x

Prior to Tyk 5.0.2, Tyk used the mgo driver which supported MongoDB 3.x to 4.4.x, but we no longer test MongoDB versions prior to 5.0 since they are EOL.
We can not guarantee full compatibility with these versions of MongoDB for Tyk and recommend upgrading to a supported MongoDB version. In particular, when using Tyk OAS APIs with Tyk 5.3.0 onwards, the minimum supported version of MongoDB is 5.0.

You can also use the following as a drop-in replacement for MongoDB:

Amazon DocumentDB 3.6 and 4 engine
Azure Cosmos DB for MongoDB 3.6 and 4 engine

Configuring MongoDB

Please check here for MongoDB driver and production configurations.

PostgreSQL Supported Versions and Drop-in Replacement

From Tyk 4.0, you can use PostgreSQL as your datastore. We support the following versions:

PostgreSQL version 12.x, 13.x, 14.x, 15.x, 16.x

You can also use the following as a drop in replacement for PostgreSQL:

Note

In a production environment, we only support the PostgreSQL versions listed above.

For POC, you can also use the following as replacement:

SQLite 3.x

Note

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.

Configuring PostgreSQL

Please check here for production configurations.

See the following pages for configuring your SQL installation with Tyk:

All data stored in SQL platforms will be identical to our existing MongoDB support.

Which platform should you use?

We recommend the following:

For PoC installations, you can use any of the following platforms (SQLite, PostgreSQL or MongoDB).
For production installations, we only support MongoDB or PostgreSQL