Skip to content

MySQL Store ​

Installation ​

bash
npm install @idempot/mysql-store mysql2

Usage ​

javascript
import { MysqlIdempotencyStore } from "@idempot/mysql-store";

const store = new MysqlIdempotencyStore({
  host: "localhost",
  port: 3306,
  database: "myapp",
  user: "root",
  password: "password"
});

// Close on shutdown
process.on("SIGINT", async () => {
  await store.close();
  process.exit(0);
});

Schema ​

The store creates a table named idempotency_records with:

  • key (VARCHAR(255), PRIMARY KEY)
  • fingerprint (VARCHAR(64), indexed)
  • status (ENUM: 'processing', 'complete')
  • response_status (INT)
  • response_headers (JSON)
  • response_body (TEXT)
  • expires_at (BIGINT, indexed)

API ​

new MysqlIdempotencyStore(options) ​

Creates a new MySQL store. Options are passed directly to mysql2.createPool().

Common Options:

  • connectionString: MySQL connection string (e.g., mysql://user:pass@host:port/db)
  • host: MySQL host (default: localhost)
  • port: MySQL port (default: 3306)
  • user: MySQL user (default: root)
  • password: MySQL password
  • database: MySQL database name

store.close() ​

Close the connection pool.