From 2a032dfc3371a0b8c21ff79aeb3c5a3d0b0bff7e Mon Sep 17 00:00:00 2001 From: Jan Prochazka Date: Mon, 16 Nov 2020 21:35:18 +0100 Subject: [PATCH] readme --- README.md | 1 + packages/api/package.json | 8 +++--- packages/datalib/package.json | 8 +++--- packages/engines/package.json | 6 ++--- packages/filterparser/package.json | 6 ++--- packages/sqltree/README.md | 39 ++++++++++++++++++++++++++++++ packages/sqltree/package.json | 14 +++++++++-- packages/tools/package.json | 4 +-- packages/types/README.md | 14 +++++++++++ packages/types/package.json | 12 ++++++++- packages/web/package.json | 10 ++++---- 11 files changed, 98 insertions(+), 24 deletions(-) create mode 100644 packages/sqltree/README.md create mode 100644 packages/types/README.md diff --git a/README.md b/README.md index dc6c169e..d42f0f56 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ DbGate is fast and efficient database administration tool. It is focused to work * Import, export from/to CSV, Excel, JSON * Free table editor - quick table data editing (cleanup data after import/before export, prototype tables etc.) * Archives - backup your data in JSON files on local filesystem (or on DbGate server, when using web application) +* Light and dark theme * For detailed info, how to run DbGate in docker container, visit [docker hub](https://hub.docker.com/r/dbgate/dbgate) ![Screenshot](https://raw.githubusercontent.com/dbshell/dbgate/master/screenshot.png) diff --git a/packages/api/package.json b/packages/api/package.json index c50faa68..00dffaa1 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,11 +1,11 @@ { "name": "@dbgate/api", "main": "src/index.js", - "version": "0.1.0", + "version": "1.0.0", "private": true, "dependencies": { - "@dbgate/engines": "^0.1.0", - "@dbgate/sqltree": "^0.1.0", + "@dbgate/engines": "^1.0.0", + "@dbgate/sqltree": "^1.0.0", "async-lock": "^1.2.4", "axios": "^0.19.0", "body-parser": "^1.19.0", @@ -36,7 +36,7 @@ "build": "webpack" }, "devDependencies": { - "@dbgate/types": "^0.1.0", + "@dbgate/types": "^1.0.0", "@types/lodash": "^4.14.149", "env-cmd": "^10.1.0", "nodemon": "^2.0.2", diff --git a/packages/datalib/package.json b/packages/datalib/package.json index b766cdcc..efebbd53 100644 --- a/packages/datalib/package.json +++ b/packages/datalib/package.json @@ -1,5 +1,5 @@ { - "version": "0.1.0", + "version": "1.0.0", "name": "@dbgate/datalib", "main": "lib/index.js", "typings": "lib/index.d.ts", @@ -12,11 +12,11 @@ "lib" ], "dependencies": { - "@dbgate/sqltree": "^0.1.0", - "@dbgate/filterparser": "^0.1.0" + "@dbgate/sqltree": "^1.0.0", + "@dbgate/filterparser": "^1.0.0" }, "devDependencies": { - "@dbgate/types": "^0.1.0", + "@dbgate/types": "^1.0.0", "@types/node": "^13.7.0", "typescript": "^3.7.5" } diff --git a/packages/engines/package.json b/packages/engines/package.json index aa0dfcfe..a829694d 100644 --- a/packages/engines/package.json +++ b/packages/engines/package.json @@ -1,17 +1,17 @@ { "name": "@dbgate/engines", - "version": "0.1.0", + "version": "1.0.0", "private": true, "main": "index.js", "typings": "./index.d.ts", "devDependencies": { - "@dbgate/types": "^0.1.0", + "@dbgate/types": "^1.0.0", "@types/lodash": "^4.14.149", "nodemon": "^2.0.2", "typescript": "^3.7.5" }, "dependencies": { "lodash": "^4.17.15", - "@dbgate/tools": "^0.1.0" + "@dbgate/tools": "^1.0.0" } } diff --git a/packages/filterparser/package.json b/packages/filterparser/package.json index b7a69696..dafc30ff 100644 --- a/packages/filterparser/package.json +++ b/packages/filterparser/package.json @@ -1,5 +1,5 @@ { - "version": "0.1.0", + "version": "1.0.0", "name": "@dbgate/filterparser", "main": "lib/index.js", "typings": "lib/index.d.ts", @@ -13,7 +13,7 @@ "lib" ], "devDependencies": { - "@dbgate/types": "^0.1.0", + "@dbgate/types": "^1.0.0", "@types/jest": "^25.1.4", "@types/node": "^13.7.0", "jest": "^24.9.0", @@ -22,7 +22,7 @@ }, "dependencies": { "@types/parsimmon": "^1.10.1", - "@dbgate/tools": "^0.1.0", + "@dbgate/tools": "^1.0.0", "lodash": "^4.17.15", "moment": "^2.24.0", "parsimmon": "^1.13.0" diff --git a/packages/sqltree/README.md b/packages/sqltree/README.md new file mode 100644 index 00000000..e010fdf2 --- /dev/null +++ b/packages/sqltree/README.md @@ -0,0 +1,39 @@ +# @dbgate/sqltree + +JavaScript/TypeScript SQL query-builder library + +@dbgate/sqltree hold query definition in RAW JSON objects. + +## Sample usage + +```javascript +const { treeToSql, dumpSqlSelect } = require('@dbgate/sqltree'); +const engines = require('@dbgate/engines'); + +const select = { + commandType: 'select', + from: { name: 'Album' }, + columns: [ + { + exprType: 'column', + columnName: 'name', + } + ] + })), + orderBy: [ + { + exprType: 'column', + columnName: 'id', + direction: 'ASC', + }, + ], +}; + +const sql = treeToSql(engines('mysql'), select, dumpSqlSelect); +console.log('Generated SQL', sqll); + +``` + +## Installation + + yarn add @dbgate/sqltree diff --git a/packages/sqltree/package.json b/packages/sqltree/package.json index 48fe55d2..8bd1e894 100644 --- a/packages/sqltree/package.json +++ b/packages/sqltree/package.json @@ -1,8 +1,18 @@ { - "version": "0.1.0", + "version": "1.0.0", "name": "@dbgate/sqltree", "main": "lib/index.js", "typings": "lib/index.d.ts", + + "homepage": "https://dbgate.org/", + "repository": { + "type": "git", + "url": "https://github.com/dbshell/dbgate.git" + }, + "funding": "https://www.paypal.com/paypalme/JanProchazkaCz/30eur", + "author": "Jan Prochazka", + "license": "GPL", + "scripts": { "prepare": "yarn build", "build": "tsc", @@ -12,7 +22,7 @@ "lib" ], "devDependencies": { - "@dbgate/types": "^0.1.0", + "@dbgate/types": "^1.0.0", "@types/node": "^13.7.0", "typescript": "^3.7.5" } diff --git a/packages/tools/package.json b/packages/tools/package.json index 2e75995b..54f9caed 100644 --- a/packages/tools/package.json +++ b/packages/tools/package.json @@ -1,5 +1,5 @@ { - "version": "0.1.0", + "version": "1.0.0", "name": "@dbgate/tools", "main": "lib/index.js", "typings": "lib/index.d.ts", @@ -13,7 +13,7 @@ "lib" ], "devDependencies": { - "@dbgate/types": "^0.1.0", + "@dbgate/types": "^1.0.0", "@types/node": "^13.7.0", "jest": "^24.9.0", "ts-jest": "^25.2.1", diff --git a/packages/types/README.md b/packages/types/README.md new file mode 100644 index 00000000..df3817c8 --- /dev/null +++ b/packages/types/README.md @@ -0,0 +1,14 @@ +# @dbgate/types + +Typescript definitions for DbGate app + + - dbinfo.d.ts - database structure definitions (tables, views, procedures, columns, primary keys, foreign keys) + - dialect.d.ts - SQL dialect definition + - dumper.d.ts - SQL dumper - dump SQL commands independed on DB engine + - engines.d.ts - definition of SQL engine driver + - query.d.ts - query results definition + + +## Installation + + yarn add --dev @dbgate/types diff --git a/packages/types/package.json b/packages/types/package.json index 2eb3c704..9f46c7e6 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,16 @@ { - "version": "0.1.0", + "version": "1.0.0", "name": "@dbgate/types", + + "homepage": "https://dbgate.org/", + "repository": { + "type": "git", + "url": "https://github.com/dbshell/dbgate.git" + }, + "funding": "https://www.paypal.com/paypalme/JanProchazkaCz/30eur", + "author": "Jan Prochazka", + "license": "GPL", + "types": "index.d.ts", "main": "", "typeScriptVersion": "2.8" diff --git a/packages/web/package.json b/packages/web/package.json index d194484f..c851ffc8 100644 --- a/packages/web/package.json +++ b/packages/web/package.json @@ -1,12 +1,12 @@ { "name": "@dbgate/web", - "version": "0.1.0", + "version": "1.0.0", "private": true, "dependencies": { "@ant-design/colors": "^5.0.0", - "@dbgate/datalib": "^0.1.0", - "@dbgate/engines": "^0.1.0", - "@dbgate/sqltree": "^0.1.0", + "@dbgate/datalib": "^1.0.0", + "@dbgate/engines": "^1.0.0", + "@dbgate/sqltree": "^1.0.0", "@mdi/font": "^5.8.55", "@testing-library/jest-dom": "^4.2.4", "@testing-library/react": "^9.3.2", @@ -54,7 +54,7 @@ ] }, "devDependencies": { - "@dbgate/types": "^0.1.0", + "@dbgate/types": "^1.0.0", "@types/react": "^16.9.17", "@types/styled-components": "^4.4.2", "typescript": "^3.7.4"