SQLX TOOLBOX (CLI USAGE)

Description

This is a toolbox for SQLX. It contains a set of tools to help you with your SQLX project.

Install dependencies

npm install

Compile

npm run compile

Run

You can install this toolbox globally with the following command in the root folder:

npm install -g

or alternatively you can run it from remote with the following command:

npx sqlx-toolbox

HELP

the following command will show you the help with all the commands:

sqlx-toolbox help

Commands

get-config

examples

sqlx-toolbox get-config -o results.json

Using the toolbox as a dependency

You can also use the toolbox as a dependency in your project. You can install it with the following command:

npm install sqlx-toolbox

Then you can use it in your code like this:

import { info as getInfo } from 'sqlx-toolbox';

...

const definitionsResult = await getInfo(); // you can pass options optionally
// or with options:
const definitionsResult = await getInfo({ out: 'results.json' });

Publishing new versions

You can publish the library with the following command:

npm publish --access public

make sure you increased the version in the package.json file.