henryjw / knex-db2 Goto Github PK

DB2 dialect for Knex

License: MIT License

JavaScript 100.00%

knex-db2's Introduction

Disclaimer: this library is in early stages of development. Use at your own risk. Please submit an issue for any bugs encounter or any questions you have.

Looking for new maintainers

If anyone would like to take ownership of this project, please contact me. I built this to simplify my life at my previous employer, but I no longer have a need for it.

Description

This is an external dialect for knex.

Limitations

Currently this dialect has limited functionality compared to the Knex built-in dialects. Below are some of the limitations:

No transaction support
No streaming support
Possibly other missing functionality

Supported functionality

Query building
Query execution (see Limitations)

Installing

npm install knex-db2

Requires Node v6 or higher.

Dependencies

npm install odbc see ODBC dependencies if you run into any issues

npm install knex

Usage

const Knex = require('knex')
const Db2Dialect = require('knex-db2')

const knex = Knex({
	client: Db2Dialect,
	connection: {
		host: 'localhost',
		database: 'knextest',
		port: 50000,
		user: 'db2inst1',
		password: 'db2inst1-pwd',
		driver: '{IBM Cli Driver}',
		connectionStringParams: {
			ALLOWPROCCALLS: 1,
			CMT: 0
		}
	},
	pool: {
		min: 2,
		max: 10
	}
})

const query = knex
	.select('*')
	.from('table1')
	.where('x', 'y')


query
	.then(result => console.log(result))
	.catch(err => console.error(err))
	.finally(() => process.exit())

ODBC dependencies

make: sudo apt install make
g++: sudo apt install g++
unix odbc: sudo apt-get install unixodbc unixodbc-dev

Configuring your driver

If you don't know the name of your installed driver, then look in look in odbcinst.ini. You can find the full path of the file by running odbcinst -j. There you should see an entry like the one below:

[IBM i Access ODBC Driver 64-bit]       <= driver name enclosed in square brackets
Description=IBM i Access for Linux 64-bit ODBC Driver
Driver=/opt/ibm/iaccess/lib64/libcwbodbc.so
Setup=/opt/ibm/iaccess/lib64/libcwbodbcs.so
Threading=0
DontDLClose=1
UsageCount=1

If that still doesn't work, then unixodbc is probably looking for the config files in the wrong directory. A common case is that the configs are in /etc but your system expects them to be somewhere else. In such case, override the path unixodbc looks in via the ODBCSYSINI and ODBCINI environment variables. E.g., ODBCINI=/etc ODBCSYSINI=/etc.

Installing default driver

Download driver

https://github.com/ibmdb/node-ibm_db#-download-clidriver-based-on-your-platform--architecture-from-the-below-ibm-hosted-url

Install driver

Extract downloaded file. This will create a clidriver folder with the driver contents
Copy this folder to wherever your system keeps drivers. If you're not sure where to put it, just copy it to /opt/ibm.
Add the configuration your /etc/odbcinst.ini file. Below is what the contents of the file should look like if your odbc path is /opt

[IBM Cli Driver]
Description=IBM CLI Driver for Linux 64-bit
Driver=/opt/ibm/clidriver/lib/libdb2.soSetup=libdb2.so.1
hreading=0
DontDLClose=1
UsageCount=1

knex-db2's People

Contributors

Stargazers

Watchers

Forkers

cmarkwell kerumen benli2023 meghnad-globalids vevedh makedatabetter thomas-mattsson

knex-db2's Issues

Setup Coveralls for code coverage

https://coveralls.io

Unable to get this up and running in a windows environment

Setup CI to run tests against min. and current Knex versions

This will help find any compatibility issues between knex versions.

Knex currently always returns `{ rowCount: -1 }` for raw queries

Example

const rawResult = await knex.raw('select * from mytable')
console.log(JSON.stringify(rawResult)) // prints "{ rowCount: -1 }"

const result = await knex.select().from('mytable')
console.log(JSON.stringify(result)) // prints "[...]"

Expectation
Running a raw query returns the same result as running a Knex query.

Are migrations supported?

Are migrations supported by knex-db2?

I am trying to apply migrations but get following error
Exception has occurred: TypeError TypeError: Cannot read property 'apply' of undefined at SchemaCompiler.toSQL (/home/adk/src/easyviz/easyviz-backend/node_modules/knex/lib/schema/compiler.js:50:26) at SchemaBuilder.toSQL (/home/adk/src/easyviz/easyviz-backend/node_modules/knex/lib/schema/builder.js:68:43) at /home/adk/src/easyviz/easyviz-backend/node_modules/knex/lib/runner.js:37:34 at tryCatcher (/home/adk/src/easyviz/easyviz-backend/node_modules/bluebird/js/release/util.js:16:23) at /home/adk/src/easyviz/easyviz-backend/node_modules/bluebird/js/release/using.js:185:26

Here is the line from compiler.js:50:
this[query.method].apply(this, query.args);

where query.method is "hasTable" and query.args is "knex_migrations".

Add git hooks using Husky

Pre-commit hooks should run linter (both test and src).
Pre-push hooks should run unit tests.

Implement using husky.

Document the min. and max. knex version that will work with this library

So far the latest knex version (0.16.3) works and so does 0.15.2. Need to find out and document what's the earliest knex version that works for this dialect.

Is IBM-400 and IBM on z/os supported

Set up integration tests to run on CI against database

Pre-reqs:

#1
Install ODBC driver
*Install DB2 Express (via Docker or directly on the host)
Start and configure DB2 instance

*TravisCI doesn't support DB2, so a workaround will be needed to implement this.

Accept raw connection string

Example:

knex({
  client: DB2Dialect,
  connection: "<db2 connection string>",
  ...
})