@runnerty/executor-sqlserver v4.0.0

Microsoft SQL Server executor for Runnerty:

Installation:

Through NPM

npm i @runnerty/executor-sqlserver

You can also add modules to your project with runnerty

npx runnerty add @runnerty/executor-sqlserver

This command installs the module in your project, adds example configuration in your config.json and creates an example plan of use.

If you have installed runnerty globally you can include the module with this command:

runnerty add @runnerty/executor-sqlserver

Configuration:

Add in config.json:

{
  "id": "sqlserver_default",
  "type": "@runnerty-executor-sqlserver",
  "user": "sa",
  "password": "yourStrong(!)Password",
  "database": "master",
  "server": "localhost",
  "port": 1433
}

{
  "id": "sqlserver_default",
  "type": "@runnerty-executor-sqlserver",
  "user": "sa",
  "password": "yourStrong(!)Password",
  "database": "master",
  "server": "localhost",
  "port": 1433,
  "options": {
    "useUTC": true
  }
}

Configuration params:

Plan sample:

Add in plan.json:

{
  "id": "sqlserver_default",
  "command_file": "/etc/runnerty/sql/test.sql"
}

{
  "id": "sqlserver_default",
  "command": "SELECT NOW()"
}

Generation of files:

The saved can be indicated in the file of the results obtained from a query in csv, xlsx and json format. These files will be generated with streams. You only have to indicate the corresponding property in the parameters:

XLSX

XLSX Format

Sample:

{
  "id": "sqlserver_default",
  "command": "SELECT * FROM USERS",
  "xlsxFileExport": "./my_output.xlsx",
  "xlsxAuthorName": "Runnerty",
  "xlsxSheetName": "MySheetSample"
}

CSV

CSV Format

Sample:

{
  "id": "sqlserver_default",
  "command": "SELECT * FROM USERS",
  "csvFileExport": "@GV(WORK_DIR)/users.csv",
  "csvOptions": {
    "delimiter": ";",
    "quote": "\""
  }
}

JSON

JSON Format

Sample:

{
  "id": "sqlserver_sample",
  "command": "SELECT * FROM USERS",
  "fileExport": "@GV(WORK_DIR)/users.json"
}

Loading files:

For file upload you must indicate the path of the csv file to be loaded in the localInFile parameter and the name of the table to load the data into in the tableName parameter. For example:

{
  "id": "sqlserver_default",
  "localInFile": "/sample.csv"
  "tableName": "dbo.TABLE_NAME"
}

Output (Process values):

Standard

• PROCESS_EXEC_MSG_OUTPUT: sqlserver output message.
• PROCESS_EXEC_ERR_OUTPUT: Error output message.

Query output

• PROCESS_EXEC_DATA_OUTPUT: sqlserver query output data.
• PROCESS_EXEC_DB_COUNTROWS: sqlserver query count rows.
• PROCESS_EXEC_DB_FIRSTROW: sqlserver query first row data.
• PROCESS_EXEC_DB_FIRSTROW_[FILED_NAME]: sqlserver first row field data.

If the process executes more than one query, it will be able to access its first row indicating its number in order, starting at zero. The first query corresponds to PROCESS_EXEC_DB_FIRSTROW, the next to PROCESS_EXEC_DB_FIRSTROW_1 and so on. The same is true for the rest of the values.

Operation output

• PROCESS_EXEC_DB_AFFECTEDROWS: sqlserver affected rows count.

If the process executes more than one operation, it will be able to access its first row indicating its number in order, starting at zero. The first operation corresponds to PROCESS_EXEC_DB_AFFECTEDROWS, the next to PROCESS_EXEC_DB_AFFECTEDROWS_1 and so on.