fonini / dsn-parser

Parse and create database connection strings fluently.

DSN Parser for Node

Parse and create database connection strings fluently.

Use case

I've setup a node app on Heroku and added a PostgreSQL database. Heroku provides the database credentials as an enviroment variable with the following form: pgsql://user:[email protected]:5432/my_db.

I needed to parse it to the following way, in order to use with node-postgres package:

var config = new DSNParser(process.env.HEROKU_POSTGRESQL_COPPER_URL).getParts();

var pool = new pg.Pool(config);

Installation

npm install dsn-parser

Usage

Parse Data Source Name

var DSNParser = require('dsn-parser');

var dsn = new DSNParser('pgsql://user:[email protected]:5432/my_db?sslmode=verify-full&application_name=myapp');
dsn.getParts();

/*
{ 
  driver: 'pgsql',
  user: 'user',
  password: 'pass',
  host: '127.0.0.1',
  port: 5432,
  database: 'my_db',
  params: { sslmode: 'verify-full', application_name: 'myapp' } 
} */

dsn.get('database'); // my_db
dsn.get('host'); // 127.0.0.1

dsn.set('driver', 'mysql');
dsn.set('user', 'root');
dsn.set('password', null);
dsn.set('port', 3306);
dsn.set('params', null);

dsn.getDSN();
// mysql://[email protected]:3306/my_db

Build new DSN

var DSNParser = require('dsn-parser');

var dsn = new DSNParser();

dsn.set('driver', 'mysql')
	.set('user', 'root')
	.set('password', 'mypass')
	.set('host', 'localhost')
	.set('port', 3306)
	.set('database', '7gh4d78sh2')
	.set('params', {
		charset: 'utf8',
		strict: true
	});

dsn.getDSN();

// mysql://root:mypass@localhost:3306/7gh4d78sh2?charset=utf8&strict=true

Run tests

npm test

Author

Jonnas Fonini

• https://fonini.github.io

License

dsn-parser's Issues

Breaks w/a password w/a `?` in it

Attempted to use a module which relies on your module to parse DSN's, however, the database password given me involved a ?. This then broke on line 38:

dsn-parser/index.js

Line 38 in c9a5348

var auth = split[2].split(':');

Caused I suspect by the exclusion of ? on line 28:

dsn-parser/index.js

Line 28 in c9a5348

'(?:([^\/?#]*)@)?' + // auth

I'm honestly not sure what the best fix for this would be or I'd issue a GitHub Pull Request. Just - it bit me, and has a non-intuitive error message as a result :/.

Example has undeclared variable

dsn is undeclared here.

var DSNParser = require('dsn-parser');

dsn.set('driver', 'mysql')

Alternative

Would you not use the generic connection-string for the same thing?