https://dbgate.io/dbgate-classic/developer/index.html Go beyond the GUI and put DbGate to work in your own tools and pipelines. Automate exports, imports and deployments with JavaScript that runs in the app or from the command line, query GraphQL/OData/OpenAPI endpoints as if they were databases, and extend DbGate with your own plugins for database drivers or file formats. This section also documents the scripting API and the SQL front matter used by the knowledge base. Hugo en-us https://dbgate.io/dbgate-classic/developer/api-connections/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://dbgate.io/dbgate-classic/developer/api-connections/index.html DbGate supports connections to REST APIs, GraphQL services, and OData endpoints. These API connections use the same interface patterns as database connections, allowing you to work with APIs and databases in a unified environment. API connection support is available in DbGate Premium. Looking for API browsing without the desktop app? DbGate Central is a separate, hosted implementation of GraphQL/oData/Shopify connections, reimplemented from the ground up for the browser. GraphQL GraphQL connections allow you to interact with GraphQL APIs. DbGate provides schema introspection and query execution capabilities. https://dbgate.io/dbgate-classic/developer/apidoc/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://dbgate.io/dbgate-classic/developer/apidoc/index.html Functions copyStream(input, output, options) ⇒ Promise Copies reader to writer. Used for import, export tables and transfer data between tables deployDb(options) Deploys database model stored in modelFolder (table as yamls) to database dropAllDbObjects(options) ⇒ Promise Drops all database objects executeQuery(options) Executes SQL query generateDeploySql(options) Generates query for deploying model into database jsonLinesReader(options) ⇒ Promise.<readerType> Reader function, which reads JSNOL file or URL. JSONL format - text file, every line is JSON encoded row. https://dbgate.io/dbgate-classic/developer/plugin-development/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://dbgate.io/dbgate-classic/developer/plugin-development/index.html DbGate supports creating plugins. Thanks plugin to wizard, it is really simple to create masic plugin. DbGate plugins are NPM (JavaScript) packages, they can have dependencies. (but not native dependencies) Now there are 3 types of plugins: Theme plugin File format plugin Database driver plugin Install prerequisites You need node.js installed. Also you will need Yeoman and yeoman DbGate plugin generator: npm install -g yo npm install -g generator-dbgate Create plugin Run following command in console: https://dbgate.io/dbgate-classic/developer/scripting/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://dbgate.io/dbgate-classic/developer/scripting/index.html DbGate consists of several NPM packages, which could be used in nodejs scripts Typically you will need these packages: dbgate-api - implements utility functions dbgate-plugin-engine - set of connector plugins, implements connection to database and operations specific to given database engine dbgate-plugin-fileformat - if you use export to CSV or XML, these format providers are implemented as external plugins Documentation of API Generating script from DbGate Lot of DbGate features are internally implemented with scripting interface. So when you are using some export-like operation, there is somewhere “Generate Shell script” button, which generates nodejs script for you. https://dbgate.io/dbgate-classic/developer/sql-front-matter/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://dbgate.io/dbgate-classic/developer/sql-front-matter/index.html SQL front matter is metadata in YAML format at the beginning of SQL file. This concept is inspired by gohugo and Jekyll, which introduced front matter for markdown files. (Front matter in Hugo) SQL front matter starts immediately at the SQL file start file mark -- >>> and ends with line containing only -- <<<. Every line of YAML content is prefixed with -- prefix, so that the whole file remains valid SQL.