A node query builder for various SQL databases, based on CodeIgniter's query builder.
- Callback and Promise API for making database calls.
- Mysql (via
- PostgreSQL (via
- Sqlite (via
npm install ci-node-query
(Versions 3.x and below work differently. Their documentation is here)
// Set the database connection detailsconst nodeQuery ="driver": "mysql""connection":"host": "localhost""user": "test""password": """database": "test";// Get the query builderconst query = nodeQuery;// As of version 3.1.0, you can also get promises// Version 5.0.0 removes all callback interfacesconst queryPromise = query;queryPromise;
As of version 4, all adapters return a standard result object, which looks similar to this:
// Result objectrows:columnName1: value1columnName2: value2columns: 'column1' 'column2'
In addition to the rows, and columns properties,
the result object has two methods,
These methods return the number of rows and columns columns in the current result.
As of version 2,
having type methods parse the values passed to look for function calls. While values passed are still passed as query parameters, take care to avoid passing these kinds of methods unfiltered input. SQL function arguments are not currently parsed, so they need to be properly escaped for the current database.
- Generated documentation is in the docs/ folder
- The API is documented in API.md
tests/adaptersfolder contains examples of how to set up a connection for the appropriate database library
- The documentation generated for the latest dev build is also Available