npm packages

packages/api/README.md

@@ -28,6 +28,21 @@ dbgateApi.runScript(run);
 
 ```
 
+Silly example, runs without any dependencies. Copy [fakeObjectReader](https://github.com/dbshell/dbgate/blob/master/packages/api/src/shell/fakeObjectReader.js) to [consoleObjectWriter](https://github.com/dbshell/dbgate/blob/master/packages/api/src/shell/consoleObjectWriter.js) .
+
+```javascript
+
+const dbgateApi = require('dbgate-api');
+async function run() {
+  const reader = await dbgateApi.fakeObjectReader();
+  const writer = await dbgateApi.consoleObjectWriter();
+  await dbgateApi.copyStream(reader, writer);
+  console.log('Finished job script');
+}
+dbgateApi.runScript(run);
+
+```
+
 ## dbgateApi functions
 
 ### dbgateApi.copyStream

packages/api/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dbgate-api",
   "main": "src/index.js",
-  "version": "1.0.1",
+  "version": "1.0.2",
 
   "homepage": "https://dbgate.org/",
   "repository": {

packages/sqltree/README.md

@@ -7,33 +7,38 @@ dbgate-sqltree hold query definition in RAW JSON objects.
 ## Sample usage
 
 ```javascript
-const { treeToSql, dumpSqlSelect } = require('dbgate-sqltree');
+const { treeToSql, dumpSqlSelect } = require("dbgate-sqltree");
-const engines = require('dbgate-engines');
+const engines = require("dbgate-engines");
 
 const select = {
-  commandType: 'select',
+  commandType: "select",
-  from: { name: 'Album' },
+  from: {
+    name: {
+      pureName: "Album",
+    },
+  },
   columns: [
     {
-        exprType: 'column',
+      exprType: "column",
-        columnName: 'name',
+      columnName: "name",
-      }
+    },
-  ]
+  ],
-  })),
   orderBy: [
     {
-      exprType: 'column',
+      exprType: "column",
-      columnName: 'id',
+      columnName: "id",
-      direction: 'ASC',
+      direction: "ASC",
     },
   ],
 };
 
-const sql = treeToSql(engines('mysql'), select, dumpSqlSelect);
+const sql = treeToSql(engines("mysql"), select, dumpSqlSelect);
-console.log('Generated SQL', sqll);
+console.log("Generated query:", sql);
 
 ```
 
+See [TypeScript definitions](https://github.com/dbshell/dbgate/blob/master/packages/sqltree/src/types.ts) for complete list of available SQL command options.
+
 ## Installation
 
     yarn add dbgate-sqltree

packages/sqltree/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.1",
+  "version": "1.0.2",
   "name": "dbgate-sqltree",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",