@acquary/cli v2.1.3

Acquary CLI

Installation

To install, just run the command below:

npm install -g @acquary/cli

Usage

ENV

First, you need to configure an ENV, that is a folder with a config.json file for azure databases config and a .cache.json file for caching MFA tokens.

You can configure multiple ENVs, and switch between them using the --env flag.

acquary configure --add prod

This will create a prod folder in the <HOME>/.acquary folder, and you should edit the config.json file to add your configuration.\ For server section, see more information here.\ For authentication, you only need to edit the authority. The clientId and clientSecret are from Azure Data Studio hehe.\ For clients, you can define a query or a list of databases.

Parameters

--add - Add a new ENV\ --remove - Remove a ENV\ --list - List all ENVs\ --test - Test a ENV connection\ --logout - Logout from a ENV (Only for MFA)

Generate

You need to generate a clients.json file to use the CLI. This is a file that contains all the databases you want to connect to or a SQL Query to get the databases.

acquary generate clients clients.json

Arguments

acquary generate <type> <file>

Where type can be clients, script or postprocess

Execute

After create a ENV and generate a file with the databases configuration, you can execute a script against all the databases.

acquary execute --env prod --clients clients.json --query "SELECT * FROM SomeTable"

Parameters

--e, --env - The ENV to use\ --c, --clients - The clients file\ --q, --query - The SQL Query to execute\ --f, --file - The SQL File to execute\ --s, --script - The javascript file to execute. See more\ --o, --output - The output format. Can be json, xls or stdout. See more\ --empty - If the output should contain empty results\ --unique - If the xls output should contain only one sheet with all the results\ --mc, --maxConcurrent - Max concurrent clients\ --mr, --maxRetries - Max retries after an error\

Script

You can also execute a javascript file that contains a function that will be executed against all the databases. See more

exports.default = async function(transaction, client) {
    const request = new Request(transaction);
    const result = await request.query("SELECT * FROM SomeTable");
    return result.recordset;
}

Stdout

With the --output stdout flag, you can pipe all databases outputs to another command.\ For example, you can pipe the output to jq to filter the result.

acquary execute --env prod --clients clients.json --query "SELECT COUNT(*) AS Qtd FROM SomeTable" --output stdout | jq '.[] | select(.Qtd > 10)'

Or to postprocess generated python script.