node-jdbc-driver is a JDBC API wrapper for Node.js, providing methods to manage database connections, execute queries and update statements, and retrieve database information such as table and column structures in a database-independent manner.
-
Simplified JDBC Usage: Provides an intuitive API to manage JDBC database connections, execute queries, and handle update statements, abstracting away low-level complexities.
-
Multiple Database Support: Seamlessly connect to different types of databases, including Hive, PostgreSQL, Tibero, and SQLite, with a unified interface.
-
Flexible Configuration: Easily configure database connections using either host, port, database name, username, and password or via custom JDBC connection with driver jars and connection URLs.
-
Connection Pooling: Benefit from built-in connection pooling support to efficiently manage and reuse database connections, enhancing application performance.
-
Query Execution: Execute custom SQL queries and retrieve results in a straightforward manner, enabling you to interact with your database effortlessly.
-
Database Structure Information: Retrieve comprehensive information about table and column structures using simple methods, enabling you to work with your database schema efficiently.
-
Data Manipulation: Perform essential data manipulation tasks such as counting rows, finding rows based on criteria, retrieving all rows from a table, and more.
-
Data Definition Language (DDL) Support: Execute DDL queries to manage the structure of your database, including creating and altering tables, views, and indexes.
To install the package, use the following command:
npm install --save node-jdbc-driverYou can initialize the JDBC driver using either CommonJS or ES6 syntax:
// CommonJS
const { default: JdbcDriver, ConnectionType } = require("node-jdbc-driver");
// ES6
import JdbcDriver, { ConnectionType } from 'node-jdbc-driver';Below are some minimal usage examples demonstrating how to use the node-jdbc-driver package.
For different types of databases, you need to provide specific connection details.
ConnectionType.hive // for hive connection
ConnectionType.postgreSql // for postgreSql connection
ConnectionType.sqlite // for sqlite connection
ConnectionType.tibero // for tibero connection
ConnectionType.custom // Establish a JDBC connection using a custom driverFor Hive and PostgreSQL connections, provide the host, port, database name, username, and password:
const host = '<host>';
const port = '<port>';
const database = '<database_name>';
const username = '<username>';
const password = '<password>';
// Set optional parameters
const minpoolsize = '<min_pool_size>'
const maxpoolsize = '<max_pool_size>'
// For Hive
const jdbc = new JdbcDriver(ConnectionType.hive, { host, port, database, username, password });
// For Hive with connection url
const jdbcUrl = 'jdbc:hive2://<host>:<port>/<database>'
const jdbc = new JdbcDriver(ConnectionType.hive, { jdbcUrl, username, password });
// For PostgreSql
const jdbc = new JdbcDriver(ConnectionType.postgreSql, { host, port, database, username, password });
// For PostgreSql with connection url
const jdbcUrl = 'jdbc:postgresql://<host>:<port>/<database>'
const jdbc = new JdbcDriver(ConnectionType.postgreSql, { jdbcUrl, username, password });
// For tibero connection
const jdbc = new JdbcDriver(ConnectionType.tibero, { host, port, database, username, password });For SQLite connections, provide the path to the SQLite database file:
const path = '<db_path>';
// Set optional parameters
const minpoolsize = '<min_pool_size>'
const maxpoolsize = '<max_pool_size>'
const jdbc = new JdbcDriver(ConnectionType.sqlite, { path }); const jdbc = new JdbcDriver(ConnectionType.custom, {
jars: 'sqlite-jdbc-3.7.2.jar', // local path of your jar file
driverClass: 'org.sqlite.JDBC', // Driver class of your jar file
jdbcUrl: 'jdbc:sqlite:/Users/jaynathray/Downloads/demo' // use jdbc url for connection
}) const jdbc = new JdbcDriver(ConnectionType.custom, {
jars: 'sqlite-jdbc-3.7.2.jar', // local path of your jar file
driverClass: 'org.sqlite.JDBC', // Driver class of your jar file
path: '/Users/jaynathray/Downloads/demo' // use path for connection
})Here are some basic operations you can perform using the node-jdbc-driver:
You can check the driver version using the following method:
const version = jdbc.get_version();To count the number of rows in a table:
const total = await jdbc.count('<table_name>');To find a single row based on a WHERE clause:
const row = await jdbc.find('<table_name>', '<where_clause>');To retrieve all rows from a table:
const rows = await jdbc.findAll('<table_name>');To execute a custom SQL query:
const results = await jdbc.sql('<sql_query>');To execute Data Definition Language (DDL) queries:
const results = await jdbc.ddl('<sql_query>');To retrieve information about table columns:
const columns = await jdbc.get_columns('<table_name>');To get properties of a table:
const tblProperties = await jdbc.get_table_properties('<table_name>');This project is licensed under the MIT License - see the LICENSE file for details.