nodejs
  1. nodejs-mysql-create-connection

Node.js MySQL Create Connection

Node.js is a popular server-side platform, while MySQL is a leading open-source Relational Database Management System (RDBMS). Together, these technologies are used to build dynamic and scalable applications such as e-commerce, social networking, and content management systems. In this tutorial, we'll discuss how to create a connection to a MySQL database using Node.js.

Syntax

The syntax for creating a connection to a MySQL database using Node.js is as follows:

const mysql = require('mysql');
const connection = mysql.createConnection({
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'mydb'
});

connection.connect((err) => {
  if (err) throw err;
  console.log('Connected!');
});

The mysql module is required to use the functionality provided by the library. The createConnection method accepts an options object definition of the database connection object parameters. After creating the connection object, the connect method is called to initiate the connection.

Example

Let's assume we have a MySQL server running on localhost, and we want to create a connection with the database named "mydb". Here's how we can create a connection:

const mysql = require('mysql');
const connection = mysql.createConnection({
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'mydb'
});

connection.connect((err) => {
  if (err) throw err;
  console.log('Connected!');
});

Output

When the code above is executed, and the connection is successful, the output will be:

Connected!

Explanation

In the example above, we first loaded the mysql module required to run the MySQL database driver in our Node.js application. We then created a MySQL database connection object using the createConnection method.

The createConnection method takes an argument of an object with the properties host, user, password, and the database name. We then initiated the connection by calling the connect method of our connection object passing a callback function as a parameter. The connect method returns a callback function with an error object as a parameter in case of errors.

The code checks for an error, and if it exists, it is thrown. Finally, the application logs that the connection was successful.

Use

Creating a connection to a MySQL database is a fundamental step when building Node.js applications using MySQL. It is needed to perform tasks such as executing SQL commands, creating, modifying, or deleting tables, and retrieving data from the database.

Important Points

  • The createConnection method is executed synchronously, and therefore, it's a blocking method. It's best to wrap it inside the connect() method's callback function.
  • Errors should always be checked when creating a connection to a MySQL database to avoid potential runtime errors in your application.
  • Connection pooling should be used for Node.js applications with high traffic to improve performance and scalability.

Summary

In this tutorial, we discussed how to create a connection to a MySQL database using Node.js. We covered the syntax, example, output, explanation, use, and important points of creating a connection to a MySQL database using Node.js. With this knowledge, you can create connections to a MySQL database in your Node.js applications, allowing you to perform operations on the database, such as executing SQL statements, getting data, and creating, modifying, or deleting tables.

Published on: