api package docs

This commit is contained in:
Jan Prochazka
2020-11-30 20:17:52 +01:00
parent a03a3416c2
commit 2c9d3abe8c
2 changed files with 6 additions and 1 deletions

2
packages/api/.yarnrc Normal file
View File

@@ -0,0 +1,2 @@
version-tag-prefix packages-api-v
version-git-message "packages-api v%s"

View File

@@ -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' },