monetdb 1.3.3 → 2.0.0

package/docs/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "docs",
+  "version": "1.0.0",
+  "description": "",
+  "main": "next.config.js",
+  "scripts": {
+    "start": "next dev",
+    "build": "next build"
+  },
+  "keywords": [],
+  "author": {
+    "name": "Svetlin Stalinov",
+    "email": "svetlin.stalinov@monetdbsolutions.com"
+  },
+  "dependencies": {
+    "next": "^14.0.1",
+    "nextra": "^2.13.2",
+    "nextra-theme-docs": "^2.13.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  }
+}

package/docs/pages/_app.js

@@ -0,0 +1,9 @@
+import 'nextra-theme-docs/style.css'
+
+export default function Nextra({ Component, pageProps }) {
+  return (
+    <>
+      <Component {...pageProps} />
+    </>
+  )
+}

package/docs/pages/_meta.json

@@ -0,0 +1,16 @@
+{
+  "index": "Getting Started",
+  "apis": "API",
+  "example": "Examples",
+  "versions": {
+      "title": "archive",
+      "type": "menu",
+      "items": {
+          "v0": {
+              "title": "v0",
+              "href": "https://github.com/MonetDB/monetdb-nodejs/blob/master/docs/v0"},
+          "v1": {
+              "title": "v1",
+              "href": "https://github.com/MonetDB/monetdb-nodejs/blob/master/docs/v1"}}
+  }
+}

package/docs/pages/apis/_meta.json

@@ -0,0 +1,4 @@
+{
+    "connection": "Connecting",
+    "result": "QueryResult"
+}

package/docs/pages/apis/connection.mdx

@@ -0,0 +1,60 @@
+## Connecting
+```ts
+const conn = new Connection(config: MapiConfig | string);
+```
+, all the optional fields get default values if not specified.
+### Using configuration options
+```ts
+interface MapiConfig {
+    database: string;
+    username?: string;
+    password?: string;
+    language?: MAPI_LANGUAGE; // sql
+    host?: string;
+    port?: number;
+    timeout?: number;
+    autoCommit?: boolean;
+    replySize?: number;
+}
+
+const defaults = {
+    host: process.env.MAPI_HOST || 'localhost',
+    port: process.env.MAPI_PORT || 50000,
+    username: process.env.MAPI_USER || 'monetdb',
+    password: process.env.MAPI_PASSWORD || 'monetdb',
+    database: process.env.MAPI_DATABASE,
+    autoCommit: false,
+    replySize: 100,
+};
+
+const config: MapiConfig = {
+    ...defaults
+    database: 'test',
+    }
+const conn = new Connection(config);
+```
+### Using URL
+```ts
+const conn = new Connection('mapi:monetdb://<username>:<password>@<hostname>:<port>/<database>');
+```
+### Connection object
+```ts
+declare class Connection extends EventEmitter {
+    autoCommit?: boolean;
+    replySize?: number;
+    sizeHeader?: boolean;
+    mapi: MapiConnection;
+    constructor(params: MapiConfig | MAPI_URI);
+    connect(callback?: ConnectCallback): Promise<boolean>;
+    close(): Promise<boolean>;
+    commit(): Promise<any>;
+    private command;
+    execute(sql: string, stream?: boolean): Promise<QueryResult|QueryStream>;
+    prepare(sql: string): Promise<PrepareStatement>;
+    setAutocommit(v: boolean): Promise<boolean>;
+    setReplySize(v: number): Promise<number>;
+    setSizeHeader(v: boolean): Promise<boolean>;
+    setTimezone(sec: number): Promise<any>;
+    rollback(): Promise<any>;
+}
+```

package/docs/pages/apis/result.mdx

@@ -0,0 +1,39 @@
+## Query Result
+The result object returned from sucessful query execution.
+```ts
+type QueryResult = {
+    id?: number;
+    type?: string;
+    queryId?: number;
+    rowCnt?: number;
+    affectedRows?: number;
+    columnCnt?: number;
+    queryTime?: number;
+    sqlOptimizerTime?: number;
+    malOptimizerTime?: number;
+    columns?: Column[];
+    headers?: ResponseHeaders;
+    data?: any[];
+};
+import { Connection } from 'monetdb';
+const conn = new Connection({database: 'test'});
+const ready = await conn.connect();
+const res: QueryResult = await conn.execute('select 1 as one, 2 as two');
+console.log(res);
+// {
+//   type: '&1',
+//   id: 1,
+//   rowCnt: 1,
+//   columnCnt: 2,
+//   queryId: 37,
+//   queryTime: 311,
+//   malOptimizerTime: 129,
+//   sqlOptimizerTime: 22,
+//   columns: [
+//     { table: '.', name: 'one', type: 'tinyint', index: 0 },
+//     { table: '.', name: 'two', type: 'tinyint', index: 1 }
+//   ],
+//   data: [ [ 1, 2 ] ]
+// }
+
+```

package/docs/pages/index.mdx

@@ -0,0 +1,27 @@
+---
+title: Getting Started
+slug: /
+---
+
+## Installation
+
+```bash
+$ npm install monetdb
+```
+
+## Usage
+The simplest way to connect is to use default connection options and pass only the database name.
+
+```js
+import { Connection} from 'monetdb'
+
+const opt = {database: 'test'}
+
+const conn = new Connection(opt)
+const ready = await conn.connect();
+const res = conn.exec('select 42');
+console.log(res.data)
+await conn.close();
+```
+, see [connection api](/apis/connection) for more details.
+

package/docs/theme.config.js

@@ -0,0 +1,35 @@
+// theme.config.js
+export default {
+  project: {
+    link: 'https://github.com/MonetDB/monetdb-nodejs',
+  },
+  docsRepositoryBase: 'https://github.com/MonetDB/monetdb-nodejs/blob/master/docs', // base URL for the docs repository
+  darkMode: true,
+  footer: true,
+  navigation: {
+    prev: true,
+    next: true,
+  },
+  footer: {
+    text: `Mozilla Public License, v.2.0 ${new Date().getFullYear()}`,
+  },
+  editLink: {
+    text: 'Edit this page on GitHub',
+  },
+  logo: (
+    <>
+      <span>monetdb-nodejs</span>
+    </>
+  ),
+  head: (
+    <>
+      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+      <meta
+        name="description"
+        content="MonetDB Node.js connector"
+      />
+      <meta name="og:title" content="monetdb-nodejs" />
+      <meta name="og:description" content="MonetDB Node.js driver" />
+    </>
+  ),
+}