dennii/dbgate
1
0
Fork 0
mirror of https://github.com/DeNNiiInc/dbgate.git synced 2026-05-01 01:33:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

apidoc

Browse Source
This commit is contained in:
Jan Prochazka
2024-11-15 14:45:31 +01:00
parent b09a558670
commit 8cb98cf643
1 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/api/README.md
View File

@@ -12,15 +12,14 @@ This example exports table Customer info CSV file.
```javascript ```javascript
const dbgateApi = require('dbgate-api'); const dbgateApi = require('dbgate-api');
const dbgatePluginMssql = require("dbgate-plugin-mssql"); const dbgatePluginMysql = require("dbgate-plugin-mysql");
const dbgatePluginCsv = require("dbgate-plugin-csv"); const dbgatePluginCsv = require("dbgate-plugin-csv");
dbgateApi.registerPlugins(dbgatePluginMssql); dbgateApi.registerPlugins(dbgatePluginMysql);
async function run() { async function run() {
const reader = await dbgateApi.tableReader({ const reader = await dbgateApi.tableReader({
connection: { server: 'localhost', engine: 'mssql', user: 'sa', password: 'xxxx', database: 'Chinook' }, connection: { server: 'localhost', engine: 'mysql@dbgate-plugin-mysql', user: 'root', password: 'xxxx', database: 'Chinook' },
schemaName: 'dbo',
pureName: 'Customer', pureName: 'Customer',
}); });
const writer = await dbgatePluginCsv.shellApi.writer({ fileName: 'Customer.csv' }); const writer = await dbgatePluginCsv.shellApi.writer({ fileName: 'Customer.csv' });
@@ -59,8 +58,8 @@ Copies data from reader into writer. Reader and writer should be created from fu
Reads table or view. Reads table or view.
```js ```js
const reader = await dbgateApi.tableReader({ const reader = await dbgateApi.tableReader({
connection: { server: 'localhost', engine: 'mssql' | 'postgres' | 'mysql', user: 'root', password: 'xxxx', database: 'DB_NAME' }, connection: { server: 'localhost', engine: 'postgres@dbgate-plugin-postgres', user: 'root', password: 'xxxx', database: 'DB_NAME' },
schemaName: 'dbo', schemaName: 'public',
pureName: 'Customer', pureName: 'Customer',
}); });
``` ```
@@ -69,7 +68,7 @@ Reads table or view.
Executes query and reads its result. Executes query and reads its result.
```js ```js
const reader = await dbgateApi.tableReader({ const reader = await dbgateApi.tableReader({
connection: { server: 'localhost', engine: 'mssql' | 'postgres' | 'mysql', user: 'root', password: 'xxxx', database: 'DB_NAME' }, connection: { server: 'localhost', engine: 'mysql@dbgate-plugin-mysql', user: 'root', password: 'xxxx', database: 'DB_NAME' },
sql: 'SELECT * FROM Album', sql: 'SELECT * FROM Album',
}); });
``` ```
@@ -81,8 +80,7 @@ Imports data into table. Options are optional, default values are false.
- createIfNotExists - create table, if not exists - createIfNotExists - create table, if not exists
```js ```js
const reader = await dbgateApi.tableWriter({ const reader = await dbgateApi.tableWriter({
connection: { server: 'localhost', engine: 'mssql' | 'postgres' | 'mysql', user: 'root', password: 'xxxx', database: 'DB_NAME' }, connection: { server: 'localhost', engine: 'mysql@dbgate-plugin-mysql', user: 'root', password: 'xxxx', database: 'DB_NAME' },
schemaName: 'dbo',
pureName: 'Customer', pureName: 'Customer',
options: { options: {
dropIfExists: false, dropIfExists: false,