drivers.md

Native Drivers for TranJS

Supported Drivers

MySQL Drivers

• mysql2
  • Use the @tranjs/mysql2 package to integrate with MySQL databases.

PostgreSQL Drivers

• pg
  • Use the @tranjs/pg package to integrate with PostgreSQL databases.

MySQL Driver

Installation

npm install @tranjs/core @tranjs/mysql2 --save

Usage

import { createPool } from "mysql2/promise";
import { useMySQLTransactionManager } from "@tranjs/mysql2";

const pool = createPool({
  host: 'localhost',
  user: 'admin',
})

// Don't need to `useTransactionManager`,
// if you use `useMySQLTransactionManager`
useMySQLTransactionManager(pool);

import { Transactional } from "@tranjs/core";
import { ctx } from "@tranjs/mysql2";

class MyService {
    @Transactional()
    async method() {
        await ctx().execute("SELECT 1;")
    }
}

That’s it! You’re ready to use TranJS with MySQL.

PostgreSQL Driver

Installation

npm install @tranjs/core @tranjs/pg --save

Usage

import { Pool } from "pg";
import { usePostgreSQLTransactionManager } from "@tranjs/pg";

const pool = new Pool({
  host: 'localhost',
  user: 'database-user',
})

// Don't need to `useTransactionManager`,
// if you use `usePostgreSQLTransactionManager`
usePostgreSQLTransactionManager(pool);

import { Transactional } from "@tranjs/core";
import { ctx } from "@tranjs/pg";

class MyService {
    @Transactional()
    async method() {
        await ctx().execute("SELECT 1;")
    }
}

That’s it! You’re ready to use TranJS with PostgreSQL.

Custom Driver

If your desired database driver isn’t available, you can always implement your own by installing just the core package. For guidance on self-implementation, refer to the Self-Implementation Guide.