Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/strongloop/loopback-connector-mssql

LoopBack connector for Microsoft SQL Server
https://github.com/strongloop/loopback-connector-mssql

hacktoberfest mssql nodejs sql

Last synced: 3 months ago
JSON representation

LoopBack connector for Microsoft SQL Server

Host: GitHub
URL: https://github.com/strongloop/loopback-connector-mssql
Owner: loopbackio
License: other
Created: 2014-01-22T05:34:06.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2023-12-15T08:41:26.000Z (11 months ago)
Last Synced: 2024-04-10T00:12:40.776Z (7 months ago)
Topics: hacktoberfest, mssql, nodejs, sql
Language: JavaScript
Homepage: http://loopback.io/doc/en/lb3/SQL-Server-connector.html
Size: 474 KB
Stars: 52
Watchers: 42
Forks: 84
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

# loopback-connector-mssql

[Microsoft SQL Server](https://www.microsoft.com/en-us/sql-server/default.aspx) is a relational database management system developed by Microsoft.
The `loopback-connector-mssql` module is the Microsoft SQL Server connector for the LoopBack framework.

For more information, see LoopBack documentation.

## Installation

In your application root directory, enter:

```shell
$ npm install loopback-connector-mssql --save
```

This will install the module from npm and add it as a dependency to the application's `package.json` file.

If you create a SQL Server data source using the data source generator as described below, you don't have to do this, since the generator will run `npm install` for you.

## Creating a SQL Server data source

Use the [Data source generator](http://loopback.io/doc/en/lb3/Data-source-generator.html) to add a SQL Server data source to your application.
The generator will prompt for the database server hostname, port, and other settings
required to connect to a SQL Server database. It will also run the `npm install` command above for you.

The entry in the application's `/server/datasources.json` will look like this (for example):

{% include code-caption.html content="/server/datasources.json" %}
```javascript
"sqlserverdb": {
"name": "sqlserverdb",
"connector": "mssql",
"host": "myhost",
"port": 1234,
"url": "mssql://username:password@dbhost/dbname",
"database": "mydb",
"password": "admin",
"user": "admin",
}
```

Edit `datasources.json` to add other properties that enable you to connect the data source to a SQL Server database.

To connect to a SQL Server instance running in Azure, you must specify a qualified user name with hostname, and add the following to the data source declaration:

```js
"options": {
"encrypt": true
...
}
```

### Connector settings

To configure the data source to use your MS SQL Server database, edit `datasources.json` and add the following settings as appropriate.
The MSSQL connector uses [node-mssql](https://github.com/patriksimek/node-mssql) as the driver. For more information about configuration parameters,
see [node-mssql documentation](https://github.com/patriksimek/node-mssql#configuration-1).

Property
Type
Default
Description

connector
String

Either "loopback-connector-mssql" or "mssql"

database
String

Database name

debug
Boolean

If true, turn on verbose mode to debug database queries and lifecycle.

host
String
localhost
Database host name

password
String

Password to connect to database

port
Number
1433
Database TCP port

schema
String
dbo
Database schema

url
String

Use instead of the host, port, user, password,
and database properties. For example: 'mssql://test:mypassword@localhost:1433/dev'.

user
String

Qualified username with host name, for example "[email protected]".

Instead of specifying individual connection properties, you can use a single `url` property that combines them into a single string, for example:

```javascript
"accountDB": {
"url": "mssql://test:mypassword@localhost:1433/demo?schema=dbo"
}
```

The application will automatically load the data source when it starts. You can then refer to it in code, for example:

{% include code-caption.html content="/server/boot/script.js" %}
```javascript
var app = require('./app');
var dataSource = app.dataSources.accountDB;
```

Alternatively, you can create the data source in application code; for example:

{% include code-caption.html content="/server/script.js" %}
```javascript
var DataSource = require('loopback-datasource-juggler').DataSource;
var dataSource = new DataSource('mssql', config);
config = { ... }; // JSON object as specified above in "Connector settings"
```

### Model discovery

The SQL Server connector supports _model discovery_ that enables you to create LoopBack models
based on an existing database schema using the unified [database discovery API](http://apidocs.strongloop.com/loopback-datasource-juggler/#datasource-prototype-discoverandbuildmodels). For more information on discovery, see [Discovering models from relational databases](https://loopback.io/doc/en/lb3/Discovering-models-from-relational-databases.html).

### Auto-migratiion

The SQL Server connector also supports _auto-migration_ that enables you to create a database schema
from LoopBack models using the [LoopBack automigrate method](http://apidocs.strongloop.com/loopback-datasource-juggler/#datasource-prototype-automigrate).
For each model, the LoopBack SQL Server connector creates a table in the 'dbo' schema in the database.

For more information on auto-migration, see [Creating a database schema from models](https://loopback.io/doc/en/lb3/Creating-a-database-schema-from-models.html) for more information.

Destroying models may result in errors due to foreign key integrity. First delete any related models by calling delete on models with relationships.

## Defining models

The model definition consists of the following properties:

* `name`: Name of the model, by default, the table name in camel-case.
* `options`: Model-level operations and mapping to Microsoft SQL Server schema/table. Use the `mssql` model property to specify additional SQL Server-specific properties for a LoopBack model.
* `properties`: Property definitions, including mapping to Microsoft SQL Server columns.
- For each property, use the `mssql` key to specify additional settings for that property/field.

For example:

{% include code-caption.html content="/common/models/inventory.json" %}
```javascript
{"name": "Inventory",
"options": {
"idInjection": false,
"mssql": {
"schema": "strongloop",
"table": "inventory"
}
}, "properties": {
"id": {
"type": "String",
"required": false,
"length": 64,
"precision": null,
"scale": null,
"mssql": {
"columnName": "id",
"dataType": "varchar",
"dataLength": 64,
"dataPrecision": null,
"dataScale": null,
"nullable": "NO"
}
},
"productId": {
"type": "String",
"required": false,
"length": 64,
"precision": null,
"scale": null,
"id": 1,
"mssql": {
"columnName": "product_id",
"dataType": "varchar",
"dataLength": 64,
"dataPrecision": null,
"dataScale": null,
"nullable": "YES"
}
},
"locationId": {
"type": "String",
"required": false,
"length": 64,
"precision": null,
"scale": null,
"id": 1,
"mssql": {
"columnName": "location_id",
"dataType": "varchar",
"dataLength": 64,
"dataPrecision": null,
"dataScale": null,
"nullable": "YES"
}
},
"available": {
"type": "Number",
"required": false,
"length": null,
"precision": 10,
"scale": 0,
"mssql": {
"columnName": "available",
"dataType": "int",
"dataLength": null,
"dataPrecision": 10,
"dataScale": 0,
"nullable": "YES"
}
},
"total": {
"type": "Number",
"required": false,
"length": null,
"precision": 10,
"scale": 0,
"mssql": {
"columnName": "total",
"dataType": "int",
"dataLength": null,
"dataPrecision": 10,
"dataScale": 0,
"nullable": "YES"
}
}
}}
```

## Type mapping

See [LoopBack types](http://loopback.io/doc/en/lb3/LoopBack-types.html) for details on LoopBack's data types.

### LoopBack to SQL Server types

LoopBack Type
SQL Server Type

Boolean
BIT

Date
DATETIME

GeoPoint
FLOAT

Number
INT

String
JSON

NVARCHAR

### SQL Server to LoopBack types

SQL Server Type
LoopBack Type

BIT
Boolean

BINARY
VARBINARY
IMAGE

Node.js Buffer object

DATE
DATETIMEOFFSET
DATETIME2
SMALLDATETIME
DATETIME
TIME

Date

POINT
GeoPoint

BIGINT
NUMERIC
SMALLINT
DECIMAL
SMALLMONEY
INT
TINYINT
MONEY
FLOAT
REAL

Number

CHAR
VARCHAR
TEXT
NCHAR
NVARCHAR
NTEXT
CHARACTER VARYING
CHARACTER

String

## Running tests

### Own instance
If you have a local or remote MSSQL instance and would like to use that to run the test suite, use the following command:
- Linux
```bash
MSSQL_HOST= MSSQL_PORT= MSSQL_USER= MSSQL_PASSWORD= MSSQL_DATABASE= CI=true npm test
```
- Windows
```bash
SET MSSQL_HOST= SET MSSQL_PORT= SET MSSQL_USER= SET MSSQL_PASSWORD= SET MSSQL_DATABASE= SET CI=true npm test
```

### Docker
If you do not have a local MSSQL instance, you can also run the test suite with very minimal requirements.
- Assuming you have [Docker](https://docs.docker.com/engine/installation/) installed, run the following script which would spawn a MSSQL instance on your local:
```bash
source setup.sh
```
where ``, ``, ``, `` and `` are optional parameters. The default values are `localhost`, `1433`, `sa`, `M55sqlT35t` and `master` respectively.
- Run the test:
```bash
npm test
```