From 2c9d3abe8cf03ef382dc7c7b73d29d360d50daad Mon Sep 17 00:00:00 2001 From: Jan Prochazka Date: Mon, 30 Nov 2020 20:17:52 +0100 Subject: [PATCH] api package docs --- packages/api/.yarnrc | 2 ++ packages/api/README.md | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 packages/api/.yarnrc diff --git a/packages/api/.yarnrc b/packages/api/.yarnrc new file mode 100644 index 000000000..34b8be9a3 --- /dev/null +++ b/packages/api/.yarnrc @@ -0,0 +1,2 @@ +version-tag-prefix packages-api-v +version-git-message "packages-api v%s" \ No newline at end of file diff --git a/packages/api/README.md b/packages/api/README.md index 89b1a47db..ac1fb40d3 100644 --- a/packages/api/README.md +++ b/packages/api/README.md @@ -11,8 +11,11 @@ Allows run DbGate data-manipulation scripts. This example exports table Customer info CSV file. ```javascript - const dbgateApi = require('dbgate-api'); +const dbgatePluginMssql = require("dbgate-plugin-mssql"); + +dbgateApi.registerPlugins(dbgatePluginMssql); + async function run() { const reader = await dbgateApi.tableReader({ connection: { server: 'localhost', engine: 'mssql', user: 'sa', password: 'xxxx', database: 'Chinook' },