https://github.com/lupennat/lupdo-mysql

Lupdo driver for MySQL & MariaDB
https://github.com/lupennat/lupdo-mysql

abstraction-layer database lupdo mariadb mysql mysql56 mysql57 mysql8 nodejs pdo transactions

Last synced: about 5 hours ago
JSON representation

Lupdo driver for MySQL & MariaDB

• Host: GitHub
• URL: https://github.com/lupennat/lupdo-mysql
• Owner: Lupennat
• License: mit
• Created: 2022-12-23T10:10:21.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-02T14:29:59.000Z (3 months ago)
• Last Synced: 2024-09-24T23:31:03.301Z (about 9 hours ago)
• Topics: abstraction-layer, database, lupdo, mariadb, mysql, mysql56, mysql57, mysql8, nodejs, pdo, transactions
• Language: TypeScript
• Homepage:
• Size: 670 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


	

        

    

	

        

    

    

        

    

    

        

    



# Lupdo-mysql

[Lupdo](https://www.npmjs.com/package/lupdo) Driver For Mysql.

## Supported Databases

-   [mysql](https://www.mysql.com/) (v5.6, 5.7, 8)

-   [mariadb](https://mariadb.org/) (v10.3, 10.4, 10.5, 10.6, 10.7, 10.8, 10.9, 10.10, 10.11)

## Third Party Library

Lupdo-mysql, under the hood, uses stable and performant npm packages:

-   [mysql2](https://github.com/sidorares/node-mysql2)

## Usage

Base Example

```js

const { createMysqlPdo } = require('lupdo-mysql');

// ES6 or Typescrypt

import { createMysqlPdo } from 'ludpo-mysql';

const pdo = createMysqlPdo(

    {

        host: 'localhost',

        port: 3306,

        user: 'user',

        password: 'password',

        database: 'database'

    },

    { min: 2, max: 3 }

);

const run = async () => {

    const statement = await pdo.query('SELECT 2');

    const res = statement.fetchArray().all();

    console.log(res);

    await pdo.disconnect();

};

run();

```

## Driver Options

[https://github.com/mysqljs/mysql#connection-options](https://github.com/mysqljs/mysql#connection-options)

> **Note**

> The `host` option also accepts a list of `host:port` the pool will generate the connection using a random host from the list.

## Mysql2 Overrides

By default Ludpo-mysql overrides user connection options with this:

```ts

{

    rowsAsArray: true,

    namedPlaceholders: true,

    dateStrings: false,

    supportBigNumbers: true,

    bigNumberStrings: true,

    decimalNumbers: false,

    typeCast: typeCast,

    timezone: 'Z',

    stringifyObjects: true,

    multipleStatements: false,

    trace: false,

    flags: [],

    queryFormat: undefined,

    debug: ${ATTR_DEBUG}

}

```

Lupdo-mysql has a custom type parser

-   `boolean` are returned as number 1 or 0.

-   `bigint` are returned as number or BigInt when necessary.

-   `binary` and `blob` are returned as Buffer.

-   `zerofill` numbers are returned as string.

-   all `geometry` are returned as json string, coordinates are identified as x,y.

-   all others types are always returned as string.

## Parameters Binding

Lupdo-mysql ignore type definition of `TypeBinding` parameter.\

Lupdo-mysql does not support array of parameters.

## Mysql Named Parameter

Lupdo-mysql support named parameter with syntax `:name`, the support is guaranteed only if all placeholder have a binding.\

## Mysql Numeric Parameter

Lupdo-mysql support numeric parameter with syntax `?`.

## Timezone and Charset

Lupdo-mysql default `charset` is `UTF8MB4_UNICODE_CI`, you can override through config.

Lupdo-mysql force `mysql2` timezone to `Z`, javascript `Date` bindings for timestamp will be converted in String using UTC timezone.

> **Warning**

> If you want to store an exact timestamp, you must bind a string or a UTC date like `new Date(Date.UTC(2023, 0, 1, 23, 22, 20, 123))`; using `new Date('2023-01-01 23:22:20.123')` will generate a UTC date based on OS timezone.

You can assign Mysql timezone through lupdo create callback in this way.

```ts

const { createMysqlPdo } = require('lupdo-mysql');

// ES6 or Typescrypt

import { createMysqlPdo } from 'ludpo-mysql';

const pdo = createMysqlPdo(

    {

        host: 'localhost',

        port: 3306,

        user: 'user',

        password: 'password',

        database: 'database'

    },

    {

        min: 2,

        max: 3,

        created: async (uuid, connection) => {

            await connection.query("SET time_zone='Europe/Rome';");

        }

    }

);

```

## Kill Connection

Lupdo-mysql support kill query.