0.1.0 • Published 5 years ago

@clearroad/api-storage-mssql v0.1.0

Weekly downloads
1
License
GPL-3.0-or-later
Repository
github
Last release
5 years ago

ClearRoad API Storage Microsoft SQL Server

Note: 5 databases will be created to store the data, all prefixed with the database value (see below). Make sure you use credentials that have the rights to create databases.

Install

npm install @clearroad/api-storage-mssql

Usage

  1. Import the library:

    Using with es6 / TypeScript

import { ClearRoad } from '@clearroad/api';
import storage from '@clearroad/api-storage-mssql';

Using with require

const ClearRoad = require('@clearroad/api').ClearRoad;
const storage = require('@clearroad/api-storage-mssql').default;
  1. Create a ClearRoad instance:
const options = {
  localStorage: {
    type: storage,
    server: 'host.com',
    user: 'user',
    password: 'passowrd',
    database: 'MyDatabase'
  },
  useQueryStorage: true // we cannot query directly with the storage, so wrap in a query storage
};
const cr = new ClearRoad('url', 'accessToken', options);

Options

PropertyTypeDescriptionRequired
localStorage.typestringConnector type. Use mssqlYes
localStorage.serverstringDatabase hostYes
localStorage.userstringDatabase userYes
localStorage.passwordstringDatabase passwordYes
localStorage.databasestringDatabase nameYes
localStorage.documentsTableNamestringDatabase table name to storage all documents. Default is documentsNo
localStorage.attachmentsTableNamestringDatabase table name to storage all attachments. Default is attachmentsNo
localStorage.timestampsbooleanAdd createdAt and updateAt fields on each row. Default is trueNo
useQueryStoragebooleanStorage needs to be wrapped in a QueryStorage. Use trueYes