ContextQMD
Back to Node Mysql2

createConnection

website/docs/examples/connections/create-connection.mdx

3.22.316.9 KB
Original Source

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import { FAQ } from '@site/src/components/FAQ'; import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';

createConnection

:::info For queries please see the Simple Queries and Prepared Statements examples. :::

createConnection(connectionUri)

createConnection(connectionUri: string)

<Tabs> <TabItem value='promise.js' default>
js
import mysql from 'mysql2/promise';

try {
  // highlight-start
  const connection = await mysql.createConnection(
    'mysql://root:password@localhost:3306/test'
  );
  // highlight-end

  // ... some query

  // Close the connection
  await connection.end();
} catch (err) {
  console.log(err);
}
</TabItem> <TabItem value='callback.js'>
js
const mysql = require('mysql2');

// highlight-start
const connection = mysql.createConnection(
  'mysql://root:password@localhost:3306/test'
);
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();
</TabItem> <TabItem value='await using'>
ts
import mysql from 'mysql2/promise';

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  await using connection = await mysql.createConnection(
    'mysql://root:password@localhost:3306/test'
  );
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> <TabItem value='using'>
ts
const mysql = require('mysql2');

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  using connection = mysql.createConnection(
    'mysql://root:password@localhost:3306/test'
  );
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> </Tabs> <hr />

createConnection(config)

createConnection(config: ConnectionOptions)

<Tabs> <TabItem value='promise.js' default>
js
import mysql from 'mysql2/promise';

try {
  // highlight-start
  const connection = await mysql.createConnection({
    host: 'localhost',
    user: 'root',
    database: 'test',
    // port: 3306,
    // password: '',
  });
  // highlight-end

  // ... some query

  // Close the connection
  await connection.end();
} catch (err) {
  console.log(err);
}
</TabItem> <TabItem value='callback.js'>
js
const mysql = require('mysql2');

// highlight-start
const connection = mysql.createConnection({
  host: 'localhost',
  user: 'root',
  database: 'test',
  // port: 3306,
  // password: '',
});
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();
</TabItem> <TabItem value='await using'>
ts
import mysql from 'mysql2/promise';

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  await using connection = await mysql.createConnection({
    host: 'localhost',
    user: 'root',
    database: 'test',
    // port: 3306,
    // password: '',
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> <TabItem value='using'>
ts
const mysql = require('mysql2');

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  using connection = mysql.createConnection({
    host: 'localhost',
    user: 'root',
    database: 'test',
    // port: 3306,
    // password: '',
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> </Tabs> <hr />

createConnection(config) — SHA1

createConnection(config: ConnectionOptions)

<Tabs> <TabItem value='promise.js' default>
js
import mysql from 'mysql2/promise';

try {
  // highlight-start
  const connection = await mysql.createConnection({
    // ...
    passwordSha1: Buffer.from(
      '8bb6118f8fd6935ad0876a3be34a717d32708ffd',
      'hex'
    ),
  });
  // highlight-end

  // ... some query

  // Close the connection
  await connection.end();
} catch (err) {
  console.log(err);
}
</TabItem> <TabItem value='callback.js'>
js
const mysql = require('mysql2');

// highlight-start
const connection = mysql.createConnection({
  // ...
  passwordSha1: Buffer.from('8bb6118f8fd6935ad0876a3be34a717d32708ffd', 'hex'),
});
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();
</TabItem> <TabItem value='await using'>
ts
import mysql from 'mysql2/promise';

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  await using connection = await mysql.createConnection({
    // ...
    passwordSha1: Buffer.from(
      '8bb6118f8fd6935ad0876a3be34a717d32708ffd',
      'hex'
    ),
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> <TabItem value='using'>
ts
const mysql = require('mysql2');

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  using connection = mysql.createConnection({
    // ...
    passwordSha1: Buffer.from(
      '8bb6118f8fd6935ad0876a3be34a717d32708ffd',
      'hex'
    ),
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> </Tabs> <hr />

createConnection(config) — SSL

createConnection(config: ConnectionOptions)

<Tabs> <TabItem value='promise.js' default>
js
import mysql from 'mysql2/promise';

try {
  // highlight-start
  const connection = await mysql.createConnection({
    // ...
    ssl: {},
  });
  // highlight-end

  // ... some query

  // Close the connection
  await connection.end();
} catch (err) {
  console.log(err);
}
</TabItem> <TabItem value='callback.js'>
js
const mysql = require('mysql2');

// highlight-start
const connection = mysql.createConnection({
  // ...
  ssl: {},
});
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();
</TabItem> <TabItem value='await using'>
ts
import mysql from 'mysql2/promise';

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  await using connection = await mysql.createConnection({
    // ...
    ssl: {},
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> <TabItem value='using'>
ts
const mysql = require('mysql2');

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  using connection = mysql.createConnection({
    // ...
    ssl: {},
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> </Tabs> <hr />

createConnection(config) — SSL Custom Certificate

createConnection(config: ConnectionOptions)

<Tabs> <TabItem value='promise.js' default>
js
import mysql from 'mysql2/promise';

try {
  // highlight-start
  const connection = await mysql.createConnection({
    // ...
    ssl: {
      // key: fs.readFileSync('./certs/client-key.pem'),
      // cert: fs.readFileSync('./certs/client-cert.pem')
      ca: fs.readFileSync('./certs/ca-cert.pem'),
    },
  });
  // highlight-end

  // ... some query

  // Close the connection
  await connection.end();
} catch (err) {
  console.log(err);
}
</TabItem> <TabItem value='callback.js'>
js
const mysql = require('mysql2');

// highlight-start
const connection = mysql.createConnection({
  // ...
  ssl: {
    // key: fs.readFileSync('./certs/client-key.pem'),
    // cert: fs.readFileSync('./certs/client-cert.pem')
    ca: fs.readFileSync('./certs/ca-cert.pem'),
  },
});
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();
</TabItem> <TabItem value='await using'>
ts
import mysql from 'mysql2/promise';

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  await using connection = await mysql.createConnection({
    // ...
    ssl: {
      // key: fs.readFileSync('./certs/client-key.pem'),
      // cert: fs.readFileSync('./certs/client-cert.pem')
      ca: fs.readFileSync('./certs/ca-cert.pem'),
    },
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> <TabItem value='using'>
ts
const mysql = require('mysql2');

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  using connection = mysql.createConnection({
    // ...
    ssl: {
      // key: fs.readFileSync('./certs/client-key.pem'),
      // cert: fs.readFileSync('./certs/client-cert.pem')
      ca: fs.readFileSync('./certs/ca-cert.pem'),
    },
  });
  // highlight-end

  // ... some query
}

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> <TabItem value='certs/ca-cert.pem'> <ExternalCodeEmbed language='plan' url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/test/fixtures/ssl/certs/ca.pem' /> 
- See [ssl/certs](https://github.com/sidorares/node-mysql2/tree/master/test/fixtures/ssl/certs).
</TabItem> </Tabs> <hr />

createConnection(config) — RDS SSL

createConnection(config: ConnectionOptions)

You can use Amazon RDS string as value to ssl property to connect to Amazon RDS MySQL over SSL.

In that case https://s3.amazonaws.com/rds-downloads/mysql-ssl-ca-cert.pem CA cert is used:

sh
npm install --save aws-ssl-profiles
<Tabs> <TabItem value='promise.js' default>
js
import mysql from 'mysql2/promise';
import awsCaBundle from 'aws-ssl-profiles';

try {
  // highlight-start
  const connection = await mysql.createConnection({
    // ...
    host: 'db.id.ap-southeast-2.rds.amazonaws.com',
    ssl: awsCaBundle,
  });
  // highlight-end

  // ... some query

  // Close the connection
  await connection.end();
} catch (err) {
  console.log(err);
}

:::info For detailed instructions, please follow the AWS SSL Profiles documentation. :::

:::tip Testing

js
try {
  const [res] = await connection.query('SHOW `status` LIKE "Ssl_cipher"');
  await connection.end();

  console.log(res);
} catch (err) {
  console.log(err);
}

:::

</TabItem> <TabItem value='callback.js'>
js
const mysql = require('mysql2');
const awsCaBundle = require('aws-ssl-profiles');

// highlight-start
const connection = mysql.createConnection({
  // ...
  host: 'db.id.ap-southeast-2.rds.amazonaws.com',
  ssl: awsCaBundle,
});
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();

:::info For detailed instructions, please follow the AWS SSL Profiles documentation. :::

:::tip Testing

js
connectionquery('SHOW `status` LIKE "Ssl_cipher"', function (err, res) {
  connection.end();

  if (err instanceof Error) {
    console.log(err);
    return;
  }

  console.log(res);
});

:::

</TabItem> <TabItem value='await using'>
ts
import mysql from 'mysql2/promise';
import awsCaBundle from 'aws-ssl-profiles';

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  await using connection = await mysql.createConnection({
    // ...
    host: 'db.id.ap-southeast-2.rds.amazonaws.com',
    ssl: awsCaBundle,
  });
  // highlight-end

  // ... some query
}

:::info For detailed instructions, please follow the AWS SSL Profiles documentation. :::

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> <TabItem value='using'>
ts
const mysql = require('mysql2');
const awsCaBundle = require('aws-ssl-profiles');

{
  // highlight-start
  // .end() is called automatically when leaving the scope
  using connection = mysql.createConnection({
    // ...
    host: 'db.id.ap-southeast-2.rds.amazonaws.com',
    ssl: awsCaBundle,
  });
  // highlight-end

  // ... some query
}

:::info For detailed instructions, please follow the AWS SSL Profiles documentation. :::

:::tip await using and using leverage Explicit Resource Management to automatically call .end() or .release() when the variable goes out of scope, so you never forget to clean up connections. :::

</TabItem> </Tabs> <hr />

createConnection(config) — Socks

createConnection(config: ConnectionOptions)

<Tabs> <TabItem value='A.js'>
js
const mysql = require('mysql2');
const SocksConnection = require('socksjs');

const socksProxy = new SocksConnection({ port: 3306 });
// highlight-start
const connection = mysql.createConnection({
  stream: socksProxy,
});
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();
</TabItem> <TabItem value='B.js'>
js
const mysql = require('mysql2');
const SocksConnection = require('socksjs');

// highlight-start
const connection = mysql.createConnection({
  debug: 1,
  stream: function () {
    return new SocksConnection({ port: 3306 });
  },
});
// highlight-end

connection.addListener('error', (err) => {
  console.log(err);
});

// ... some query

// Close the connection
connection.end();
</TabItem> </Tabs>

:::tip Testing

js
connection.execute('SELECT SLEEP(1.1) AS `www`', (err, rows, fields) => {
  if (err instanceof Error) {
    console.log(err);
    return;
  }

  console.log(rows, fields);
});

connection.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
  if (err instanceof Error) {
    console.log(err);
    return;
  }

  console.log(rows, fields);
});

connection.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
  if (err instanceof Error) {
    console.log(err);
    return;
  }

  console.log(rows, fields);
});

:::

<hr />

Glossary

ConnectionOptions

<FAQ title='ConnectionOptions Specification'> <ExternalCodeEmbed language='ts' url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts' extractMethod='ConnectionOptions' methodType='interface' /> </FAQ>