update

README.md

@@ -2,77 +2,196 @@
 NodeJS client for [ClickHouse](https://clickhouse.yandex/).
 Send query over HTTP interface.
 
+Install:
+
+```bash
+npm i clickhouse
+```
+
 Example:
 
 ```javascript
-var async = require('async');
+const { ClickHouse } = require('clickhouse');
+
+const clickhouse = new ClickHouse();
+```
+or with all options:
+
+```javascript
+const clickhouse = new ClickHouse({
+	url: 'http://localhost',
+	port: 8123,
+	debug: false,
+	basicAuth: null,
+	isUseGzip: false,
+	config: {
+		session_timeout                         : 60,
+		output_format_json_quote_64bit_integers : 0,
+		enable_http_compression                 : 0
+	},
+
+	// This object merge with request params (see request lib docs)
+	reqParams: {
+		...
+	}
+});
+```
+
+or change 
+
+	basicAuth: null
+to
+
+	basicAuth: {
+	username: 'default',
+	password: '',
+	},
+
+
+***
 
-var query = 'SELECT FlightDate, DestCityName, AirlineID, DestStateFips FROM ontime LIMIT 10';
-var ch = new ClickHouse({
-	url   : 'http://localhost',
-	port  : 8123,
-	debug : false
+Exec query:
+```javascript
+const queries = [
+	'DROP TABLE IF EXISTS session_temp',
+
+	`CREATE TABLE session_temp (
+		date Date,
+		time DateTime,
+		mark String,
+		ips Array(UInt32),
+		queries Nested (
+			act String,
+			id UInt32
+		)
+	)
+	ENGINE=MergeTree(date, (mark, time), 8192)`,
+
+	'OPTIMIZE TABLE ukit.loadstat PARTITION 201807 FINAL'
+];
+
+for(const query of queries) {
+	const r = await clickhouse.query(query).toPromise();
+
+	console.log(query, r);
+}
+````
+
+***
+
+Exec by callback way:
+```javascript
+clickhouse.query(query).exec(function (err, rows) {
+	...
 });
+````
 
-async.parallel(
-	[
-		function (cb) {
+***
 
-			// single query
-			ch.query(query, function (err, rows) {
-				console.log('single query result', err, rows);
-
-				cb(err);
-			});
-		},
-
-		function (cb) {
-			var error = null;
-
-			// query with data streaming
-			ch.query(query)
-				.on('data', function (data) {
-					console.log('data', data);
-				})
-				.on('error', function (err) {
-					error = err;
-				})
-				.on('end', function () {
-					cb(error);
-				});
+Stream:
+```javascript
+clickhouse.query(`SELECT number FROM system.numbers LIMIT 10`).stream()
+	.on('data', function() {
+		const stream = this;
+
+		stream.pause();
+
+		setTimeout(() => {
+			stream.resume();
+		}, 1000);
+	})
+	.on('error', err => {
+		...
+	})
+	.on('end', () => {
+		...
+	});
+```
+
+or **async** stream:
+```javascript
+// async iteration
+for await (const row of clickhouse.query(sql).stream()) {
+	console.log(row);
+}
+```
+
+***
+
+As promise:
+```javascript
+const rows = await clickhouse.query(query).toPromise();
+
+// use query with external data
+const rows = await clickhouse.query('SELECT * AS count FROM temp_table', {
+	external: [
+		{
+			name: 'temp_table',
+			data: e._.range(0, rowCount).map(i => `str${i}`)
 		},
+	]
+}).toPromise();
+```
+
+***
+
+Set session:
+```javascript
+clickhouse.sessionId = '...';
+const r = await clickhouse.query(
+	`CREATE TEMPORARY TABLE test_table
+	(_id String, str String)
+	ENGINE=Memory`
+).toPromise();
+````
 
-		function(cb) {
-
-			// insert rows
-			ch.insertMany(
-				'sometable',
-				[
-					// row 1
-					[
-						'2016-07-02',
-						'1',
-						12
-					],
-
-					// row 2
-					[
-						'2016-07-03',
-						'2',
-						30
-					]
-				],
-				function(err, result) {
-					if (err)  return cb(err);
-
-					console.log('insert result', result);
-				}
-			);
-		}
-	],
-	function () {
-		process.exit();
+
+Insert stream:
+```javascript
+const ws = clickhouse.insert('INSERT INTO session_temp').stream();
+for(let i = 0; i <= 1000; i++) {
+	await ws.writeRow(
+		[
+			e._.range(0, 50).map(
+				j => `${i}:${i * 2}:${j}`
+			).join('-')
+		]
+	);
+}
+
+//wait stream finish
+const result = await ws.exec();
+```
+
+***
+
+Pipe readable stream to writable stream (across transform):
+```javascript
+const rs = clickhouse.query(query).stream();
+
+const tf = new stream.Transform({
+	objectMode : true,
+	transform  : function (chunk, enc, cb) {
+		cb(null, JSON.stringify(chunk) + '\n');
 	}
-);
+});
+
+clickhouse.sessionId = Date.now();
+const ws = clickhouse.insert('INSERT INTO session_temp2').stream();
+
+const result = await rs.pipe(tf).pipe(ws).exec();
+```
+
+***
 
-```
+**Changelogs**:
+* 2019-02-13
+	- Add compatibility with user and username options 
+* 2019-02-07
+	- Add TLS/SSL Protocol support
+	- Add async iteration over SELECT
+
+
+
+**Links**
+* request lib doc https://github.com/request/request#requestoptions-callback

index.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+
+declare module 'clickhouse' {
+  import {Stream} from 'stream';
+
+  type callbackExec = (error: Error, rows?: Object[]) => void;
+
+  export class ClickHouse {
+    constructor(opts: Object);
+    query(query: String, reqParams?: object): QueryCursor;
+    insert(query: String, data?: object): QueryCursor;
+    sessionId: string;
+  }
+
+  export class WriteStream extends stream.Transform {
+    writeRow(data: Array<any>);
+    exec();
+  }
+
+  class QueryCursor {
+    async toPromise(): Promise<Object[]>;
+    exec(callback: callbackExec);
+    stream(): Stream | WriteStream;
+  }
+}