MySQL setup

This is needed only if you are running the SuperTokens core yourself.

1️⃣ Create a database 🛠️

CREATE DATABASE supertokens;

You can skip this step if you want SuperTokens to write to your own database. In this case, you will need to provide your database name as shown in the step below.

2️⃣ Connect SuperTokens to your database 🔌

# NOTE: MYSQL_HOST being localhost / 127.0.0.1 will not work in a docker image.
# Please provide the database's local / public hostname or IP address

 docker run \
    -p 3567:3567 \
    -e MYSQL_USER=<TO DO> \
    -e MYSQL_PASSWORD=<TO DO> \
    -e MYSQL_HOST=<TO DO> \
    -e MYSQL_PORT=<Default: 3306> \
    -e MYSQL_DATABASE_NAME=<Default: supertokens> \
    -d supertokens/supertokens-mysql
  • If you have not assigned any password for the user, please make MYSQL_PASSWORD be equal to "".
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

mysql_user:

mysql_password:

mysql_host: # Default: "localhost"

mysql_port: # Default: 3306

mysql_database_name: # Default: "supertokens"
  • If you have not assigned any password for the user, please make mysql_password be equal to "".

3️⃣ Create tables 👩‍💻👨‍💻

This happens automatically, unless you provide a MySQL user that doesn't have table creation permission.

CREATE TABLE IF NOT EXISTS key_value (
    name VARCHAR(128),
    value TEXT,
    created_at_time BIGINT UNSIGNED,
    PRIMARY KEY(name)
);

CREATE TABLE IF NOT EXISTS session_info (
    session_handle VARCHAR(255) NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    refresh_token_hash_2 VARCHAR(128) NOT NULL,
    session_data TEXT,
    expires_at BIGINT UNSIGNED NOT NULL,
    created_at_time BIGINT UNSIGNED NOT NULL,
    jwt_user_payload TEXT,
    PRIMARY KEY(session_handle)
);

CREATE TABLE IF NOT EXISTS emailpassword_users (
    user_id CHAR(36) NOT NULL,
    email VARCHAR(256) NOT NULL UNIQUE,
    password_hash VARCHAR(128) NOT NULL,
    time_joined BIGINT UNSIGNED NOT NULL,
    is_email_verified TINYINT(1) NOT NULL,
    PRIMARY KEY (user_id)
);

CREATE INDEX emailpassword_user_pagination_index ON emailpassword_users(time_joined DESC, user_id DESC);

CREATE TABLE IF NOT EXISTS emailpassword_pswd_reset_tokens (
    user_id CHAR(36) NOT NULL,
    token VARCHAR(128) NOT NULL UNIQUE,
    token_expiry BIGINT UNSIGNED NOT NULL,
    PRIMARY KEY (user_id, token),
    FOREIGN KEY (user_id) REFERENCES emailpassword_users (user_id) ON DELETE CASCADE ON UPDATE CASCADE
);

CREATE INDEX emailpassword_password_reset_token_expiry_index ON emailpassword_pswd_reset_tokens(token_expiry);

CREATE TABLE IF NOT EXISTS emailpassword_email_verification_tokens (
    user_id CHAR(36) NOT NULL,
    token VARCHAR(128) NOT NULL UNIQUE,
    token_expiry BIGINT UNSIGNED NOT NULL,
    email VARCHAR(256),
    PRIMARY KEY (user_id, token),
    FOREIGN KEY (user_id) REFERENCES emailpassword_users (user_id) ON DELETE CASCADE ON UPDATE CASCADE
);

CREATE INDEX emailpassword_email_verification_token_expiry_index ON emailpassword_email_verification_tokens(token_expiry);

You also have the option to rename these tables if you want. Please see this guide for more information.

4️⃣ Test the connection 🤞

To test, start SuperTokens and run the following query in your database

SELECT * FROM key_value;

If you see at least one row, it means that the connection has been successfully completed! 🥳🎉

← Managed ServicePostgreSQL →