loopback-connector-mssql

Microsoft SQL Server is a relational database management system developed by Microsoft.
The loopback-connector-mssql module is the Microsoft SQL Server connector for the LoopBack framework.

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 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
...
}
`

$3

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 as the driver. For more information about configuration parameters,
see node-mssql documentation.

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"
`

$3

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. For more information on discovery, see Discovering models from relational databases.

$3

The SQL Server connector also supports _auto-migration_ that enables you to create a database schema
from LoopBack models using the LoopBack automigrate method.
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 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 for details on LoopBack's data types.

$3

$3

Running tests

$3