Skip to content

MonetDB/monetdb-nodejs

Repository files navigation

MonetDB Node.js

Linux macOS MonetDB-dev-builds npm version

Node.js connector for MonetDB.

Getting Started

npm install monetdb

, connect with default options

import { Connection } from monetdb

const opt: MapiConfig = {
    database: 'your_database'
}

const conn = new Connection(opt);

, or using mapi URL

import { Connection } from monetdb
const conn = new Connection('mapi:monetdb://<username>:<password>@<hostname>:<port>/<database>');

, then run some queries

    const ready: boolean = await conn.connect();
    const res: QueryResult = await conn.execute('select 42');
    ...
    const closed: boolean = await conn.close();

, for detailed api documentation please visit documentation.

Features

  • prepared statements
  • streaming query results
  • bulk import & export with COPY INTO

Contributing

We ❤️ contributions!

We will happily accept your pull request if it:

  • has tests
  • looks reasonable
  • does not break backwards compatibility

If your change has breaking backwards compatibility please please point that out in the pull request. When you open an issue please provide:

  • version of Node
  • version of MonetDB
  • smallest possible snippet of code to reproduce the problem

Setting up for local development

  • clone the repo
  • run npm i && npm run build in root folder
  • have MonetDB running with test database. For more information on how to get started with MonetDB please visit MonetDB Documentation
  • run tests with npm t