node-firebird 0.9.6 → 1.0.0

package/.github/workflows/node.js.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-16.04, ubuntu-18.04, windows-2019, macos-10.15]
+        node-version: [10.x, 12.x, 14.x, 15.x]
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 10
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Firebird install (Linux)
+      if: matrix.os == 'ubuntu-16.04' || matrix.os == 'ubuntu-18.04'
+      run: |
+        if [ `lsb_release -rs` = '16.04' ]
+        then
+            sudo apt-get install libtommath0
+        else
+            sudo apt-get install libtommath1
+            sudo ln -s /usr/lib/x86_64-linux-gnu/libtommath.so.1 /usr/lib/x86_64-linux-gnu/libtommath.so.0
+        fi
+        wget -nv -O Firebird-3.0.7.33374-0.amd64.tar.gz "https://github.com/FirebirdSQL/firebird/releases/download/R3_0_7/Firebird-3.0.7.33374-0.amd64.tar.gz"
+        tar xzvf Firebird-3.0.7.33374-0.amd64.tar.gz
+        (cd Firebird-3.0.7.33374-0.amd64; sudo ./install.sh -silent)
+        sudo usermod -a -G firebird `whoami`
+
+    - name: Firebird install (MacOS)
+      if: matrix.os == 'macos-10.15'
+      run: |
+        wget -nv -O Firebird-3.0.7-33374-x86_64.pkg "https://github.com/FirebirdSQL/firebird/releases/download/R3_0_7/Firebird-3.0.7-33374-x86_64.pkg"
+        sudo installer -verbose -pkg "Firebird-3.0.7-33374-x86_64.pkg" -target /
+        
+    - name: Firebird install (Windows)
+      if: matrix.os == 'windows-2019'
+      shell: cmd
+      run: |
+        set FB_ZIP=Firebird-3.0.7.33374-1_x64.zip
+        powershell Invoke-WebRequest "https://github.com/FirebirdSQL/firebird/releases/download/R3_0_7/$env:FB_ZIP" -OutFile "$env:FB_ZIP"
+        7z x -oC:\Firebird %FB_ZIP%
+
+    - name: Build
+      shell: bash
+      run: |
+        npm ci         
+
+    - name: Test (Linux)
+      if: matrix.os == 'ubuntu-16.04' || matrix.os == 'ubuntu-18.04'
+      run: |
+        sg firebird -c "npx nyc npm test"
+
+    - name: Test (MacOS)
+      if: matrix.os == 'macos-10.15'
+      run: |
+        sudo mkdir `pwd`/tmp-node-fb
+        sudo chmod 777 `pwd`/tmp-node-fb
+        export ISC_USER=sysdba
+        export ISC_PASSWORD=masterkey
+        export NODE_FB_TEST_TMP_DIR=`pwd`/tmp-node-fb
+        npx nyc npm test
+
+    - name: Test (Windows)
+      if: matrix.os == 'windows-2019'
+      shell: cmd
+      run: |
+        set PATH=C:\Firebird;%PATH%
+        call npx nyc npm test

package/README.md

@@ -49,7 +49,7 @@ var Firebird = require('node-firebird');
 - `Firebird.attach(options, function(err, db))` attach a database
 - `Firebird.create(options, function(err, db))` create a database
 - `Firebird.attachOrCreate(options, function(err, db))` attach or create database
-- `Firebird.pool(max, options, function(err, db)) -> return {Object}` create a connection pooling
+- `Firebird.pool(max, options) -> return {Object}` create a connection pooling
 
 ## Connection types
 
@@ -66,7 +66,8 @@ options.password = 'masterkey';
 options.lowercase_keys = false; // set to true to lowercase keys
 options.role = null;            // default
 options.pageSize = 4096;        // default when creating database
-
+options.pageSize = 4096;        // default when creating database
+options.retryConnectionInterval = 1000; // reconnect interval in case of connection drop
 ```
 
 ### Classic
@@ -183,7 +184,7 @@ Firebird.attach(options, function(err, db) {
 });
 ```
 
-### Reading Blobs (Aasynchronous)
+### Reading Blobs (Asynchronous)
 
 ```js
 Firebird.attach(options, function(err, db) {
@@ -345,6 +346,24 @@ console.log(sql3);
 console.log(sql4);
 ```
 
+### Using GDS codes
+
+```js
+var { GDSCode } = require('node-firebird/lib/gdscodes');
+/*...*/
+db.query('insert into my_table(id, name) values (?, ?)', [1, 'John Doe'],
+    function (err) {
+        if(err.gdscode == GDSCode.UNIQUE_KEY_VIOLATION){
+            console.log('constraint name:'+ err.gdsparams[0]);
+            console.log('table name:'+ err.gdsparams[0]);
+            /*...*/
+        }
+        /*...*/
+    });
+
+```
+
+
 ### Service Manager functions
 
 - backup
@@ -402,7 +421,7 @@ var fbsvc = {
 ### Backup Service example
 
 ```js
-
+const options = {...}; // Classic configuration with manager = true
 Firebird.attach(options, function(err, svc) {
     if (err)
         return;
@@ -417,14 +436,17 @@ Firebird.attach(options, function(err, svc) {
                    ]
         },
         function(err, data) {
-            console.log(data);
-        });
+            data.on('data', line => console.log(line));
+            data.on('end', () => svc.detach());
+        }
+    );
+});
 ```
 
 ### Restore Service example
 
 ```js
-const config = {...}; // Clasic configuration with manager = true
+const config = {...}; // Classic configuration with manager = true
 const RESTORE_OPTS = {
     database: 'database.fdb',
     files: ['backup.fbk']
@@ -492,7 +514,7 @@ 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
+for Firebird 3.0 you need to add the following in firebird.conf according to Firebird 3 release notes
 <https://firebirdsql.org/file/documentation/release_notes/html/en/3_0/rnfb30-security-new-authentication.html>
 
 ```bash
@@ -501,6 +523,21 @@ WireCrypt = Disabled
 UserManager = Legacy_UserManager
 ```
 
+Firebird 4 wire protocol is not supported yet so
+for Firebird 4.0 you need to add the following in firebird.conf according to Firebird release notes
+<https://firebirdsql.org/file/documentation/release_notes/html/en/4_0/rlsnotes40.html#rnfb40-config-srp256>
+
+```bash
+AuthServer = Srp256, Srp, Legacy_Auth
+WireCrypt = Disabled
+UserManager = Legacy_UserManager
+```
+
+Please read also Authorization with Firebird 2.5 client library from Firebird 4 migration guide
+<https://ib-aid.com/download/docs/fb4migrationguide.html#_authorization_with_firebird_2_5_client_library_fbclient_dll>
+
+
+
 ## Contributors
 
 - Henri Gourvest, <https://github.com/hgourvest>