SQL Configuration
Introduction
How you configure your SQL platform depends on whether you are installing Tyk from fresh using our supported SQL platforms, or are migrating from an existing MongoDB instance.
Prerequisites
In a production environment, Tyk only supports the following PostgreSQL versions in v4.0.0:
- PostgreSQL - versions 13.3, 12.7, 11.12, 10.17, 9.6.22
Migrating from an existing MongoDB instance
For v4.0 we have provided a migration command that will help you migrate all data from the main storage layer (APIs, Policies, Users, UserGroups, Webhooks, Certificates, Portal Settings, Portal Catalogues, Portal Pages, Portal CSS etc.).
Note
The migration tool will not migrate any Logs, Analytics or Uptime analytics data.
- Make sure your new SQL platform and the existing MongoDB instance are both running
- Configure the
main
part ofstorage
section of yourtyk-analytics.conf
:
{
...
"storage": {
...
"main": {
"type": "postgres",
"connection_string": "user=root password=admin database=tyk-demo-db host=tyk-db port=5432"
}
}
}
- Run the following command:
./tyk-analytics migrate-sql
You will see output listing the transfer of each database table. For example: Migrating 'tyk_apis' collection. Records found: 7
.
- You can now remove your
mongo_url
(orTYK_DB_MONGOURL
environment variable) from yourtyk-analytics.conf
- Restart your Tyk Dashboard