Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/runnerty/executor-sqlserver

Runnerty module: Microsoft SQL Server executor
https://github.com/runnerty/executor-sqlserver

csv runnerty sql-server xlsx

Last synced: about 1 month ago
JSON representation

Runnerty module: Microsoft SQL Server executor

Host: GitHub
URL: https://github.com/runnerty/executor-sqlserver
Owner: runnerty
License: mit
Created: 2018-09-06T08:56:23.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2023-08-09T09:05:27.000Z (over 1 year ago)
Last Synced: 2024-09-23T15:08:31.281Z (4 months ago)
Topics: csv, runnerty, sql-server, xlsx
Language: JavaScript
Size: 676 KB
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Smart Processes Management

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]

# Microsoft SQL Server executor for [Runnerty]:

### Installation:

Through NPM

```bash
npm i @runnerty/executor-sqlserver
```

You can also add modules to your project with [runnerty]

```bash
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:

```bash
runnerty add @runnerty/executor-sqlserver
```

### Configuration:

Add in [config.json]:

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

```json
{
"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]:

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

```json
{
"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:

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

#### CSV

CSV Format

| Parameter | Description |
| :-------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| csvFileExport | Path of csv file export. |
| csvOptions/headers | Type: boolean/string[]. The headers will be auto detected from the first row or you can to provide headers array: ['h1name','h2name',...]. |
| csvOptions/delimiter | Alternate delimiter. (Default: ',') |
| csvOptions/quote | Alternate quote. (Default: '"') |
| csvOptions/alwaysWriteHeaders | Set to true if you always want headers written, even if no rows are written. (Default: false) |
| csvOptions/rowDelimiter | Specify an alternate row delimiter (i.e \r\n). (Default: '\n') |
| csvOptions/quoteHeaders | If true then all headers will be quoted. (Default: quoteColumns value) |
| csvOptions/quoteColumns | If true then columns and headers will be quoted (unless quoteHeaders is specified). (Default: false). More info [here.](https://c2fo.io/fast-csv/docs/formatting/options/#quotecolumns) |
| csvOptions/escape | Alternate escaping value. (Default: '"') |
| csvOptions/includeEndRowDelimiter | Set to true to include a row delimiter at the end of the csv. (Default: false) |
| csvOptions/writeBOM | Set to true if you want the first character written to the stream to be a utf-8 BOM character. (Default: false) |

Sample:

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

#### JSON

JSON Format

Sample:

```json
{
"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:

```json
{
"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.

[runnerty]: http://www.runnerty.io
[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-sqlserver.svg
[npm-url]: https://www.npmjs.com/package/@runnerty/executor-sqlserver
[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-sqlserver.svg
[david-badge]: https://david-dm.org/runnerty/executor-sqlserver.svg
[david-badge-url]: https://david-dm.org/runnerty/executor-sqlserver
[config.json]: https://docs.runnerty.io/config/
[plan.json]: https://docs.runnerty.io/plan/