Pure JavaScript and Asynchronous Firebird client for Node.js
Firebird forum on Google Groups.
Firebird database on social networks
Changelog for version v0.2.x
- 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
Installation
npm install node-firebird
Usage
var Firebird = ;
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(max, options) -> return {Object}
create a connection pooling
Connection types
Connection options
var options = {}; optionshost = '127.0.0.1';optionsport = 3050;optionsdatabase = 'database.fdb';optionsuser = 'SYSDBA';optionspassword = 'masterkey';optionslowercase_keys = false; // set to true to lowercase keysoptionsrole = null; // defaultoptionspageSize = 4096; // default when creating database
Classic
Firebird;
Pooling
// 5 = the number is count of opened socketsvar pool = Firebird; // Get a free poolpool; // Destroy poolpool;
Database object (db)
Database 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;
BLOB (stream)
Firebird;
BLOB (buffer)
Firebird;
Reading Blobs (Aasynchronous)
Firebird;
Streaming a big data
Firebird;
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;
Events
Firebird;
Escaping Query values
var sql1 = 'SELECT * FROM TBL_USER WHERE ID>' + Firebird;var sql2 = 'SELECT * FROM TBL_USER WHERE NAME=' + Firebird;var sql3 = 'SELECT * FROM TBL_USER WHERE CREATED<=' + Firebird;var sql4 = 'SELECT * FROM TBL_USER WHERE NEWSLETTER=' + Firebird; // or db.escape() console;console;console;console;
Using GDS codes
var GDSCode = ;/*...*/db;
Service Manager functions
- backup
- restore
- fixproperties
- serverinfo
- database validation
- commit transaction
- rollback transaction
- recover transaction
- database stats
- users infos
- user actions (add modify remove)
- get firebird file log
- tracing
// each row : fctname : [params], typeofreturnvar fbsvc = "backup" : "options" "stream" "nbackup" : "options" "stream" "restore" : "options" "stream" "nrestore" : "options" "stream" "setDialect": "database""dialect" "stream" "setSweepinterval": "database""sweepinterval" "stream" "setCachebuffer" : "database""nbpagebuffers" "stream" "BringOnline" : "database" "stream" "Shutdown" : "database""shutdown""shutdowndelay""shutdownmode" "stream" "setShadow" : "database""activateshadow" "stream" "setForcewrite" : "database""forcewrite" "stream" "setReservespace" : "database""reservespace" "stream" "setReadonlyMode" : "database" "stream" "setReadwriteMode" : "database" "stream" "validate" : "options" "stream" "commit" : "database" "transactid" "stream" "rollback" : "database" "transactid" "stream" "recover" : "database" "transactid" "stream" "getStats" : "options" "stream" "getLog" : "options" "stream" "getUsers" : "username" "object" "addUser" : "username" "password" "options" "stream" "editUser" : "username" "options" "stream" "removeUser" : "username""rolename" "stream" "getFbserverInfos" : "options" "options" "object" "startTrace" : "options" "stream" "suspendTrace" : "options" "stream" "resumeTrace" : "options" "stream" "stopTrace" : "options" "stream" "getTraceList" : "options" "stream" "hasActionRunning" : "options" "object"
Backup Service example
const options = ...; // Classic configuration with manager = trueFirebird;
Restore Service example
const config = ...; // Classic configuration with manager = trueconst RESTORE_OPTS = database: 'database.fdb' files: 'backup.fbk'; Firebird;
getLog and getFbserverInfos Service examples with use of stream and object return
fb;
Charset for database connection is always UTF-8
node-firebird doesn't let you choose the charset connection, it will always use UTF-8. 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.
Firebird 3.0 Support
Firebird new wire protocol is not supported yet so for Firebird 3.0 you need to add the following in firebird.conf according to Firebird documentation https://firebirdsql.org/file/documentation/release_notes/html/en/3_0/rnfb30-security-new-authentication.html
AuthServer = Srp, Legacy_AuthWireCrypt = DisabledUserManager = Legacy_UserManager
Contributors
- Henri Gourvest, https://github.com/hgourvest
- Popa Marius Adrian, https://github.com/mariuz
- Peter Širka, https://github.com/petersirka