Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agracio/edge-ms-sql
https://github.com/agracio/edge-ms-sql
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/agracio/edge-ms-sql
- Owner: agracio
- License: mit
- Created: 2017-05-04T17:30:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T14:37:51.000Z (7 months ago)
- Last Synced: 2024-05-21T02:36:20.888Z (6 months ago)
- Language: C#
- Size: 47.9 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
edge-ms-sql
=======
# This package is now deprecated in favor of `edge-sql`
## NPM: https://www.npmjs.com/package/edge-sql
## GitHub: https://github.com/agracio/edge-sql
MS SQL Server compiler for [Edge.js](https://github.com/agracio/edge-js). It allows accessing SQL Sever databases from Node.js using Edge.js and ADO.NET.
This is a fork of [edge-sql](https://github.com/tjanczuk/edge-sql) providing improvements to the original implementation.
## Why use `edge-ms-sql`?
Differences from `edge-sql`
* Provides optional `commandTimeout` parameter to set SQL command timeout. [SqlCommand.CommandTimeout](https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlcommand.commandtimeout(v=vs.110).aspx)
* Attempts to treat all other types of SQL statements as `select` instead of throwing exception. This allows to execute complex SQL queries that declare variables and temp tables before running `select` statement.
* Supports returning multiple results from query.
## Usage
### Supported SQL statements
* **select**
* **update**
* **insert**
* **delete**
* **exec**
All other statements will be interpreted as `select` and will try to use `ExecuteReaderAsync` .NET method of `SqlCommand` class instance.
### Basic usage
You can set your SQL connection string using environment variable. For passing connection string as a parameter see [Advanced usage](#advanced-usage).
```
set EDGE_SQL_CONNECTION_STRING=Data Source=localhost;Initial Catalog=Northwind;Integrated Security=True
```
#### Simple select
```js
const edge = require('edge-js');
var getTop10Products = edge.func('ms-sql', function () {/*
select top 10 * from Products
*/});
getTop10Products(null, function (error, result) {
if (error) throw error;
console.log(result);
});
```
#### Parameterized queries
You can construct a parameterized query once and provide parameter values on a per-call basis:
**SELECT**
```js
const edge = require('edge-js');
var getProduct = edge.func('ms-sql', function () {/*
select * from Products
where ProductId = @myProductId
*/});
getProduct({ myProductId: 10 }, function (error, result) {
if (error) throw error;
console.log(result);
});
```
**UPDATE**
```js
const edge = require('edge-js');
var updateProductName = edge.func('ms-sql', function () {/*
update Products
set ProductName = @newName
where ProductId = @myProductId
*/});
updateProductName({ myProductId: 10, newName: 'New Product' }, function (error, result) {
if (error) throw error;
console.log(result);
});
```
### Advanced usage
##### Using parameterised function
```js
const edge = require('edge-js');
var select = edge.func('ms-sql', {
source: 'select top 10 * from Products',
connectionString: 'SERVER=myserver;DATABASE=mydatabase;Integrated Security=SSPI',
commandTimeout: 100
});
select(null, function (error, result) {
if (error) throw error;
console.log(result);
});
```
##### Stored proc with input parameters
```js
const edge = require('edge-js');
var storedProcParams = {inputParm1: 'input1', inputParam2: 25};
var select = edge.func('ms-sql', {
source: 'exec myStoredProc',
connectionString: 'SERVER=myserver;DATABASE=mydatabase;Integrated Security=SSPI'
});
select(storedProcParams, function (error, result) {
if (error) throw error;
console.log(result);
});
```