feat: add mariadb connector

docker-compose.yaml

@@ -16,3 +16,12 @@ services:
       MYSQL_DATABASE: db0
       MYSQL_USER: test
       MYSQL_PASSWORD: test
+  mariadb:
+    # https://hub.docker.com/_/mariadb
+    image: mariadb
+    ports: ["3307:3306"]
+    environment:
+      MARIADB_ROOT_PASSWORD: test
+      MARIADB_DATABASE: db0
+      MARIADB_USER: test
+      MARIADB_PASSWORD: test

docs/2.connectors/mariadb.md

@@ -0,0 +1,30 @@
+---
+icon: simple-icons:mariadb
+---
+
+# MariaDB
+
+> Connect DB0 to MariaDB Database using mariadb
+
+## Usage
+
+For this connector, you need to install [`mariadb`](https://www.npmjs.com/package/mariadb) dependency:
+
+:pm-install{name="mariadb"}
+
+Use `mariadb` connector:
+
+```js
+import { createDatabase } from "db0";
+import mariadb from "db0/connectors/mariadb";
+
+const db = createDatabase(
+  mariadb({
+    /* options */
+  }),
+);
+```
+
+## Options
+
+:read-more{to="https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/main/types/share.d.ts#L603"}

package.json

@@ -60,6 +60,7 @@
     "eslint": "^10.0.3",
     "eslint-config-unjs": "^0.6.2",
     "jiti": "^2.6.1",
+    "mariadb": "^3.4.5",
     "mlly": "^1.8.1",
     "mysql2": "^3.20.0",
     "obuild": "^0.4.32",
@@ -76,6 +77,7 @@
     "@libsql/client": "*",
     "better-sqlite3": "*",
     "drizzle-orm": "*",
+    "mariadb": "*",
     "mysql2": "*",
     "sqlite3": "*"
   },
@@ -92,6 +94,9 @@
     "mysql2": {
       "optional": true
     },
+    "mariadb": {
+      "optional": true
+    },
     "@electric-sql/pglite": {
       "optional": true
     },

src/_connectors.ts

@@ -9,14 +9,15 @@ import type { ConnectorOptions as LibSQLCoreOptions } from "db0/connectors/libsq
 import type { ConnectorOptions as LibSQLHttpOptions } from "db0/connectors/libsql/http";
 import type { ConnectorOptions as LibSQLNodeOptions } from "db0/connectors/libsql/node";
 import type { ConnectorOptions as LibSQLWebOptions } from "db0/connectors/libsql/web";
+import type { ConnectorOptions as MariaDBOptions } from "db0/connectors/mariadb";
 import type { ConnectorOptions as MySQL2Options } from "db0/connectors/mysql2";
 import type { ConnectorOptions as NodeSQLiteOptions } from "db0/connectors/node-sqlite";
 import type { ConnectorOptions as PgliteOptions } from "db0/connectors/pglite";
 import type { ConnectorOptions as PlanetscaleOptions } from "db0/connectors/planetscale";
 import type { ConnectorOptions as PostgreSQLOptions } from "db0/connectors/postgresql";
 import type { ConnectorOptions as SQLite3Options } from "db0/connectors/sqlite3";
 
-export type ConnectorName = "better-sqlite3" | "bun-sqlite" | "bun" | "cloudflare-d1" | "cloudflare-hyperdrive-mysql" | "cloudflare-hyperdrive-postgresql" | "libsql-core" | "libsql-http" | "libsql-node" | "libsql" | "libsql-web" | "mysql2" | "node-sqlite" | "sqlite" | "pglite" | "planetscale" | "postgresql" | "sqlite3";
+export type ConnectorName = "better-sqlite3" | "bun-sqlite" | "bun" | "cloudflare-d1" | "cloudflare-hyperdrive-mysql" | "cloudflare-hyperdrive-postgresql" | "libsql-core" | "libsql-http" | "libsql-node" | "libsql" | "libsql-web" | "mariadb" | "mysql2" | "node-sqlite" | "sqlite" | "pglite" | "planetscale" | "postgresql" | "sqlite3";
 
 export type ConnectorOptions = {
   "better-sqlite3": BetterSQLite3Options;
@@ -32,6 +33,7 @@ export type ConnectorOptions = {
   /** alias of libsql-node */
   "libsql": LibSQLNodeOptions;
   "libsql-web": LibSQLWebOptions;
+  "mariadb": MariaDBOptions;
   "mysql2": MySQL2Options;
   "node-sqlite": NodeSQLiteOptions;
   /** alias of node-sqlite */
@@ -56,6 +58,7 @@ export const connectors: Record<ConnectorName, string> = Object.freeze({
   /** alias of libsql-node */
   "libsql": "db0/connectors/libsql/node",
   "libsql-web": "db0/connectors/libsql/web",
+  "mariadb": "db0/connectors/mariadb",
   "mysql2": "db0/connectors/mysql2",
   "node-sqlite": "db0/connectors/node-sqlite",
   /** alias of node-sqlite */

src/connectors/mariadb.ts

@@ -0,0 +1,71 @@
+import mariadb from "mariadb";
+import type { Connector, Primitive } from "db0";
+import { BoundableStatement } from "./_internal/statement.ts";
+
+export type ConnectorOptions = mariadb.ConnectionConfig;
+
+type InternalQuery = (
+  sql: string,
+  params?: unknown[],
+) => Promise<mariadb.UpsertResult | Record<string, unknown>[]>;
+
+export default function mariadbConnector(
+  opts: ConnectorOptions,
+): Connector<mariadb.Connection> {
+  let _connection: mariadb.Connection | undefined;
+  const getConnection = async () => {
+    if (_connection) {
+      return _connection;
+    }
+
+    _connection = await mariadb.createConnection({
+      ...opts,
+    });
+
+    return _connection;
+  };
+
+  const query: InternalQuery = (sql, params) =>
+    getConnection().then((c) => c.query(sql, params));
+
+  return {
+    name: "mariadb",
+    dialect: "mariadb",
+    getInstance: () => getConnection(),
+    exec: (sql) => query(sql),
+    prepare: (sql) => new StatementWrapper(sql, query),
+    dispose: async () => {
+      await _connection?.end?.();
+      _connection = undefined;
+    },
+  };
+}
+
+class StatementWrapper extends BoundableStatement<void> {
+  #query: InternalQuery;
+  #sql: string;
+
+  constructor(sql: string, query: InternalQuery) {
+    super();
+    this.#sql = sql;
+    this.#query = query;
+  }
+
+  async all(...params: Primitive[]) {
+    const res = await this.#query(this.#sql, params);
+    return res as Record<string, unknown>[];
+  }
+
+  async run(...params: Primitive[]) {
+    const res = (await this.#query(this.#sql, params)) as mariadb.UpsertResult;
+    return {
+      success: true,
+      ...res,
+    };
+  }
+
+  async get(...params: Primitive[]) {
+    const res = await this.#query(this.#sql, params);
+    return (res as Record<string, unknown>[])[0];
+  }
+}

src/types.ts

@@ -3,7 +3,12 @@
  */
 export type Primitive = string | number | boolean | undefined | null;
 
-export type SQLDialect = "mysql" | "postgresql" | "sqlite" | "libsql";
+export type SQLDialect =
+  | "mysql"
+  | "postgresql"
+  | "sqlite"
+  | "libsql"
+  | "mariadb";
 
 export type Statement = {
   /**

test/connectors/_tests.ts

@@ -40,7 +40,8 @@ export function testConnector<TConnector extends Connector = Connector>(opts: {
   it("drop and create table", async () => {
     await db.sql`DROP TABLE IF EXISTS users`;
     switch (opts.dialect) {
-      case "mysql": {
+      case "mysql":
+      case "mariadb": {
         await db.sql`CREATE TABLE users (\`id\` VARCHAR(4) PRIMARY KEY, \`firstName\` TEXT, \`lastName\` TEXT, \`email\` TEXT)`;
         break;
       }
@@ -53,7 +54,8 @@ export function testConnector<TConnector extends Connector = Connector>(opts: {
 
   it("insert", async () => {
     switch (opts.dialect) {
-      case "mysql": {
+      case "mysql":
+      case "mariadb": {
         await db.sql`INSERT INTO users VALUES (${userId}, 'John', 'Doe', '')`;
         break;
       }

test/connectors/mariadb.test.ts

@@ -0,0 +1,16 @@
+import { describe } from "vitest";
+import connector from "../../src/connectors/mariadb";
+import { testConnector } from "./_tests";
+
+describe.runIf(process.env.MARIADB_URL)("connectors: mariadb.test", () => {
+  testConnector({
+    dialect: "mariadb",
+    connector: connector({
+      host: "localhost",
+      port: 3307,
+      user: "test",
+      password: "test",
+      database: "db0",
+    }),
+  });
+});