Pure JavaScript Firebird client for Node.js.
Pure JavaScript and Asynchronous Firebird client for Node.js. Firebird forum on Google Groups. Please share and follow Firebird database, it's a very good open-source product.
Firebird database on social networks
New version v0.2.0 supports
- added auto-reconnect
- added sequentially selects
- events for connection (attach, detach, row, result, transaction, commit, rollback, error, etc.)
- performance improvements
- supports inserting/updating buffers and streams
- reading blobs (sequentially)
- pooling
database.detach()
waits for last command- better unit-test
- best of use with total.js - web application framework for node.js
Installation
npm install firebirdsql
Usage
var Firebird = require('firebirdsql');
Methods
Firebird.escape(value) -> return {String}
- prevent for SQL InjectionsFirebird.attach(options, function(err, db))
attach a databaseFirebird.create(options, function(err, db))
create a databaseFirebird.attachOrCreate(options, function(err, db))
attach or create databaseFirebird.pool(maxSockets, options, function(err, db)) -> return {Object}
create a connection pooling
## Connection types
Connection options
var options = {};
options.host = '127.0.0.1';
options.database = 'database.fdb';
options.user = 'SYSDBA';
options.password = 'masterkey';
Classic
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.query('SELECT * FROM TABLE', function(err, result) {
db.detach();
});
});
Pooling
var pool = Firebird.pool(5, options);
pool.get(function(err, db) {
if (err)
throw err;
db.query('SELECT * FROM TABLE', function(err, result) {
db.detach();
});
});
pool.detach();
pool.destroy();
Database object (db)
Methods
db.query(query, [params], function(err, result))
- classic query, returns Array of Objectdb.execute(query, [params], function(err, result))
- classic query, returns Array of Arraydb.sequentially(query, [params], function(row, index), function(err))
- sequentially querydb.detach(function(err))
detach a databasedb.transaction(isolation, function(err, transaction))
create transaction
Transaction methods
transaction.query(query, [params], function(err, result))
- classic query, returns Array of Objecttransaction.execute(query, [params], function(err, result))
- classic query, returns Array of Arraytransaction.commit(function(err))
commit current transactiontransaction.rollback(function(err))
rollback current transaction
Examples
PARAMETRIZED QUERIES
### Parameters
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.query('INSERT INTO USERS (ID, ALIAS, CREATED) VALUES(?, ?, ?) RETURNING ID', [1, 'Pe\'ter', new Date()] function(err, result) {
console.log(result[0].id);
db.query('SELECT * FROM USERS WHERE Alias=?', ['Peter'], function(err, result) {
console.log(result);
db.detach();
});
});
});
BLOB (stream)
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.query('INSERT INTO USERS (ID, ALIAS, FILE) VALUES(?, ?, ?)', [1, 'Peter', fs.createReadStream('/users/image.jpg')] function(err, result) {
db.detach();
});
});
BLOB (buffer)
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.query('INSERT INTO USERS (ID, ALIAS, FILE) VALUES(?, ?, ?)', [1, 'Peter', fs.readFileSync('/users/image.jpg')] function(err, result) {
db.detach();
});
});
READING BLOBS (ASYNCHRONOUS)
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.query('SELECT ID, ALIAS, USERPICTURE FROM USER', function(err, rows) {
if (err)
throw err;
rows[0].userpicture(function(err, name, e) {
if (err)
throw err;
e.on('data', function(chunk) {
});
e.on('end', function() {
db.detach();
});
});
});
});
STREAMING A BIG DATA
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.sequentially('SELECT * FROM BIGTABLE', function(row, index) {
stream.write(JSON.stringify(row));
}, function(err) {
db.detach();
});
});
TRANSACTIONS
Transaction types:
Firebird.ISOLATION_READ_UNCOMMITTED
Firebird.ISOLATION_READ_COMMITED
Firebird.ISOLATION_REPEATABLE_READ
Firebird.ISOLATION_SERIALIZABLE
Firebird.ISOLATION_READ_COMMITED_READ_ONLY
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.transaction(Firebird.ISOLATION_READ_COMMITED, function(err, transaction) {
transaction.query('INSERT INTO users VALUE(?,?)', [1, 'Janko'], function(err, result) {
if (err) {
transaction.rollback();
return;
}
transaction.commit(function(err) {
if (err)
transaction.rollback();
else
db.detach();
});
});
});
});
EVENTS
Firebird.attach(options, function(err, db) {
if (err)
throw err;
db.on('row', function(row, index, isObject) {
});
db.on('result', function(result) {
});
db.on('attach', function() {
});
db.on('detach', function(isPoolConnection) {
});
db.on('reconnect', function() {
});
db.on('error', function(err) {
});
db.on('transaction', function(isolation) {
});
db.on('commit', function() {
});
db.on('rollback', function() {
});
db.detach();
});
Escaping query values
var sql1 = 'SELECT * FROM TBL_USER WHERE ID>' + Firebird.escape(1);
var sql2 = 'SELECT * FROM TBL_USER WHERE NAME=' + Firebird.escape('Pe\'er');
var sql3 = 'SELECT * FROM TBL_USER WHERE CREATED<=' + Firebird.escape(new Date());
var sql4 = 'SELECT * FROM TBL_USER WHERE NEWSLETTER=' + Firebird.escape(true);
console.log(sql1);
console.log(sql2);
console.log(sql3);
console.log(sql4);
Charset for database connection is always UTF-8
firebirdsql doesn't let you chose the charset connection, it will always use UTF8.
Node is unicode, no matter if your database is using another charset to store string or blob, Firebird will transliterate automatically.
This is why you should use Firebird 2.5 server at least.
## Contributors