6.2.1 • Published 5 months ago

dbgate-api v6.2.1

Weekly downloads
19
License
GPL-3.0
Repository
github
Last release
5 months ago

dbgate-api

Allows run DbGate data-manipulation scripts.

Installation

yarn add dbgate-api

Usage

This example exports table Customer info CSV file.

const dbgateApi = require('dbgate-api');
const dbgatePluginMysql = require("dbgate-plugin-mysql");
const dbgatePluginCsv = require("dbgate-plugin-csv");

dbgateApi.registerPlugins(dbgatePluginMysql);

async function run() {
  const reader = await dbgateApi.tableReader({
    connection: { server: 'localhost', engine: 'mysql@dbgate-plugin-mysql', user: 'root', password: 'xxxx', database: 'Chinook' },
    pureName: 'Customer',
  });
  const writer = await dbgatePluginCsv.shellApi.writer({ fileName: 'Customer.csv' });
  await dbgateApi.copyStream(reader, writer);

  console.log('Finished job script');
}
dbgateApi.runScript(run);

Silly example, runs without any dependencies. Copy fakeObjectReader to consoleObjectWriter .

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

Copies data from reader into writer. Reader and writer should be created from functions listed below.

  await dbgateApi.copyStream(reader, writer);

dbgateApi.tableReader

Reads table or view.

  const reader = await dbgateApi.tableReader({
    connection: { server: 'localhost', engine: 'postgres@dbgate-plugin-postgres', user: 'root', password: 'xxxx', database: 'DB_NAME' },
    schemaName: 'public',
    pureName: 'Customer',
  });

dbgateApi.queryReader

Executes query and reads its result.

  const reader = await dbgateApi.tableReader({
    connection: { server: 'localhost', engine: 'mysql@dbgate-plugin-mysql', user: 'root', password: 'xxxx', database: 'DB_NAME' },
    sql: 'SELECT * FROM Album',
  });

dbgateApi.tableWriter

Imports data into table. Options are optional, default values are false.

  • dropIfExists - if table already exists, it is dropped before import
  • truncate - delete table content before import
  • createIfNotExists - create table, if not exists
  const reader = await dbgateApi.tableWriter({
    connection: { server: 'localhost', engine: 'mysql@dbgate-plugin-mysql', user: 'root', password: 'xxxx', database: 'DB_NAME' },
    pureName: 'Customer',
    options: {
      dropIfExists: false,
      truncate: false,
      createIfNotExists: false,
    }
  });

dbgateApi.jsonLinesReader

Reads JSON lines data file. On first line could be structure. Every line contains one row as JSON serialized object.

  const reader = await dbgateApi.jsonLinesReader({
    fileName: 'test.jsonl',
    encoding: 'utf-8',
    header: true,
    limitRows: null
  });

dbgateApi.jsonLinesWriter

Writes JSON lines data file. On first line could be structure. Every line contains one row as JSON serialized object.

  const reader = await dbgateApi.jsonLinesWriter({
    fileName: 'test.jsonl',
    encoding: 'utf-8',
    header: true
  });
6.2.1

5 months ago

6.2.0

5 months ago

6.1.6

6 months ago

6.1.5

6 months ago

6.1.4

6 months ago

6.1.3

7 months ago

6.1.2

7 months ago

6.1.1

7 months ago

6.1.0

7 months ago

6.0.0-alpha.1

8 months ago

6.0.0

8 months ago

5.5.7-alpha.68

8 months ago

5.5.7-alpha.60

8 months ago

5.5.7-alpha.50

8 months ago

5.5.7-alpha.53

8 months ago

5.5.7-alpha.52

8 months ago

5.5.7-alpha.51

8 months ago

5.5.7-alpha.43

9 months ago

5.5.7-alpha.40

9 months ago

5.5.7-alpha.47

8 months ago

5.5.7-alpha.45

8 months ago

5.5.7-alpha.44

8 months ago

5.5.7-alpha.48

8 months ago

5.5.7-alpha.32

9 months ago

5.5.7-alpha.33

9 months ago

5.5.7-alpha.25

9 months ago

5.5.7-alpha.29

9 months ago

5.5.7-alpha.28

9 months ago

5.5.7-alpha.27

9 months ago

5.5.7-alpha.26

9 months ago

5.5.7-alpha.16

9 months ago

5.5.6

9 months ago

5.4.5-alpha.5

11 months ago

5.4.5-alpha.3

11 months ago

5.4.5-alpha.4

11 months ago

5.4.4

11 months ago

5.4.3

11 months ago

5.4.2

11 months ago

5.4.1

11 months ago

5.4.0

11 months ago

5.5.4-alpha.3

10 months ago

5.5.4-alpha.4

10 months ago

5.5.4-alpha.7

10 months ago

5.5.4-alpha.8

10 months ago

5.5.4-alpha.1

10 months ago

5.5.4-alpha.2

10 months ago

5.5.5

10 months ago

5.5.4

10 months ago

5.5.3

10 months ago

5.5.2

10 months ago

5.5.1

10 months ago

5.5.0

10 months ago

5.3.4

12 months ago

5.3.3

12 months ago

5.3.1

1 year ago

5.3.0

1 year ago

5.2.9

1 year ago

5.2.8

1 year ago

5.2.7

2 years ago

5.2.7-alpha.1

2 years ago

5.2.6

2 years ago

5.2.5

2 years ago

5.2.4-alpha.1

2 years ago

5.2.4

2 years ago

5.2.3

2 years ago

5.1.7-alpha.13

3 years ago

5.1.7-alpha.14

3 years ago

5.2.2-alpha.13

2 years ago

5.2.2-alpha.12

2 years ago

5.2.2-alpha.11

2 years ago

5.2.2

2 years ago

5.2.1

3 years ago

5.2.0

3 years ago

5.1.6

3 years ago

5.1.5

3 years ago

5.1.4

3 years ago

5.1.3

3 years ago

5.1.2

3 years ago

5.1.1

3 years ago

5.0.9

3 years ago

5.0.8

3 years ago

5.0.7

3 years ago

5.0.6

3 years ago

5.0.6-alpha.2

3 years ago

5.1.0

3 years ago

5.0.4-alpha.2

3 years ago

5.0.4-alpha.7

3 years ago

5.0.4-alpha.8

3 years ago

5.0.0-alpha.1

3 years ago

5.0.5

3 years ago

5.0.4

3 years ago

5.0.3

3 years ago

5.0.2

3 years ago

5.0.1

3 years ago

5.0.0

3 years ago

4.8.8

3 years ago

4.8.5

3 years ago

4.8.4

3 years ago

4.8.7

3 years ago

4.8.6

3 years ago

4.7.4-alpha.12

3 years ago

4.7.4-alpha.10

3 years ago

4.7.4-alpha.15

3 years ago

4.7.4-alpha.16

3 years ago

4.7.4-alpha.14

3 years ago

4.7.2

3 years ago

4.7.4

3 years ago

4.7.3

3 years ago

4.7.4-alpha.1

3 years ago

4.7.4-alpha.3

3 years ago

4.7.4-alpha.2

3 years ago

4.7.4-alpha.8

3 years ago

4.7.4-alpha.7

3 years ago

4.8.1

3 years ago

4.8.0

3 years ago

4.8.3

3 years ago

4.8.2

3 years ago

4.7.3-alpha.3

3 years ago

4.7.3-alpha.5

3 years ago

4.7.3-alpha.2

3 years ago

4.7.1

3 years ago

4.6.1

3 years ago

4.4.3

4 years ago

4.6.0

3 years ago

4.4.2

4 years ago

4.4.5-alpha.1

4 years ago

4.6.3

3 years ago

4.6.2

3 years ago

4.4.4

4 years ago

4.5.0

4 years ago

4.7.0

3 years ago

4.5.1

4 years ago

4.4.1

4 years ago

4.4.0

4 years ago

4.4.0-alpha.2

4 years ago

4.3.4

4 years ago

4.4.0-alpha.1

4 years ago

4.3.3

4 years ago

4.3.2

4 years ago

4.3.1

4 years ago

4.3.0

4 years ago

4.2.8

4 years ago

4.2.7

4 years ago

4.2.6

4 years ago

4.2.5

4 years ago

4.2.4

4 years ago

4.1.9

4 years ago

4.1.10

4 years ago

4.1.11

4 years ago

4.1.12

4 years ago

4.2.3

4 years ago

4.2.2

4 years ago

4.2.1

4 years ago

4.2.0

4 years ago

4.1.8

4 years ago

4.1.7

4 years ago

4.1.4

4 years ago

4.1.3

4 years ago

4.1.6

4 years ago

4.1.5

4 years ago

4.1.1

4 years ago

4.1.0

4 years ago

4.0.3

4 years ago

4.0.1

4 years ago

4.0.0

4 years ago

4.0.2

4 years ago

3.9.6

4 years ago

3.9.6-alpha.14

4 years ago

3.9.6-alpha.13

4 years ago

3.9.6-alpha.12

4 years ago

3.9.6-alpha.11

4 years ago

3.9.6-alpha.10

4 years ago

3.9.6-alpha.9

4 years ago

3.9.6-alpha.8

4 years ago

3.9.6-alpha.7

4 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago