Need private packages and team management tools?Check out npm Orgs. »


1.0.13 • Public • Published

Microsoft SQL Server (MSSQL) Connector

The Microsoft SQL Server data connector is a plugin for API Builder that can connect to your MSSQL instance and interrogate your schema that will automatically provision Models into to your project, and optionally, automatically generate a rich CRUD API to the underlying tables. The Models can be used programmatically, or can be used within the flow editor to interact with your database.

Minimum requirements

Supported versions

  • SQL Server 2008 or later


  • ~8 MB

Disk space

  • ~15 MB

Supported features

  • Automatic generation of Models from SQL tables
  • Automatic generation of API for Models
  • Full CRUD operations on tables via Models


npm install --no-optional @axway/api-builder-plugin-dc-mssql

A configuration file is generated for you and placed into the conf directory of your API Builder project. By default, we use a host of localhost, and expect user and password to come from the OS host environment.


Once the plugin is installed, the configuration file is located <project>/conf/mssql.default.js.

Option name Type Description
connector string Must be: @axway/api-builder-plugin-dc-mssql
user string The user with which to connect to the database.
password string The user's password with which to connect to the database.
host string The database host.
port number The database post.
database string The database instance name.
connectionTimeout number Connection timeout in MS
requestTimeout number Request timeout in MS
generateModelsFromSchema boolean If enabled, API Builder will automatically interrogate the database and auto-generate Models from SQL tables.
modelAutogen boolean If enabled, API Builder will automatically generate a full and rich CRUD API from the generated Models.
options object MSSQL Connection options
options.encrypt boolean Encrypt the database connection. Required when connecting to Azure


After you configure the connector, you can start up your API Builder project and visit the console (normally found under http://localhost:8080/console). Your connector will be listed under the Connectors section of the console.

Your database tables will be listed under the Models section of the console. You can now click on the gear icon to the right of the table names and generate flow based APIs.

You can also reference the connector in a custom model.

const Account = APIBuilder.Model.extend('Account', {
  fields: {
    Name: { type: String, required: true }
  connector: 'mssql'

If you want to map a specific model to a specific table, use metadata. For example, to map the account model to the table named accounts, set it such as:

const Account = APIBuilder.Model.extend('account', {
  fields: {
    Name: { type: String, required: false, validator: /[a-zA-Z]{3,}/ }
  connector: 'mssql',
  metadata: {
    'mssql': {
      table: 'accounts'

Known issues and limitations



  • #6026: Documents ranges of supported Node.js versions in package.json


  • #6074: Internal CI chore


  • #5704: Fixes issue where distinct failed to paginate with error: ORDER BY items must appear in the select list if SELECT DISTINCT is specified


  • #5711: Internal cleanup of dependencies.


  • #5711: Internal cleanup of npm scripts.



  • #5715: Internal changes to remove integration tests.


  • #5709: Internal changes to update eslint rules.


  • #5707: Internal cleanup to code coverage during build process.


  • #4544: Initial Implementation


This code is proprietary, closed source software licensed to you by Axway. All Rights Reserved. You may not modify Axway’s code without express written permission of Axway. You are licensed to use and distribute your services developed with the use of this software and dependencies, including distributing reasonable and appropriate portions of the Axway code and dependencies. Except as set forth above, this code MUST not be copied or otherwise redistributed without express written permission of Axway. This module is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement (General Conditions) located here:; EXCEPT THAT IF YOU RECEIVED A FREE SUBSCRIPTION, LICENSE, OR SUPPORT SUBSCRIPTION FOR THIS CODE, NOTWITHSTANDING THE LANGUAGE OF THE GENERAL CONDITIONS, AXWAY HEREBY DISCLAIMS ALL SUPPORT AND MAINTENANCE OBLIGATIONS, AS WELL AS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED INFRINGEMENT WARRANTIES, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND YOU ACCEPT THE PRODUCT AS-IS AND WITH ALL FAULTS, SOLELY AT YOUR OWN RISK. Your right to use this software is strictly limited to the term (if any) of the license or subscription originally granted to you.


npm i @axway/api-builder-plugin-dc-mssql

Downloadsweekly downloads








last publish


  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability