MySQL data connector for Axway API Builder


2.3.03 months ago4 years agoMinified + gzip package size for @axway/api-builder-plugin-dc-mysql in KB


MySQL Connector

The MySQL data connector is a plugin for API Builder that can connect to your MySQL database 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

  • MySQL 5.7


  • ~7 MB

Disk space

  • ~10 MB

Supported features

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


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

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/mysql.default.js.

Option name Type Description
connector string Must be: @axway/api-builder-plugin-dc-mysql
connectionPooling boolean boolean Enables connection pooling for better performance and scalability.
connectionLimit number Number of simultaneous connections when connectionPooling is enabled.
host string The database host.
port number The database post.
database string The database instance name.
user string The user with which to connect to the database.
password string The user's password with which to connect to the database.
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.


The mysql library used by this connector depends on a MySQL server setting NO_BACKSLASH_ESCAPES to mitigate against SQL injection attacks. This setting must be disabled (which is the default setting for MySQL servers).


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: 'mysql'

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: 'mysql',
  metadata: {
    'mysql': {
      table: 'accounts'

Known issues and limitations

  1. Only supports SQL tables.
  2. Does not support views.
  3. Does not support stored procedures.



  • #6933: Replace peerDependency on @axway/api-builder-runtime with engines.apibuilder.


  • #7057: Updated documentation links.


  • #7008: Fixed the issue where the plugin configuration file is not installed correctly if the project conf directory does not exist.


  • #6934: Internal refactoring around code style.



  • #6815: Internal tooling changes.


  • #6315: Internal chore.


  • #6116: Internal cleanup chore.


  • #6114: Refactor code for style, security and performance improvements.


  • #6115: Internal fix for Sonar scans.


  • #6105: Non-primary-key fields named 'id' are no longer filtered out from generated Models. This specific fix requires at least API Builder 4.17.4 which introduces support for fields named 'id'.


  • #6074: Internal CI chore


  • #5700: Previously, Mysql connector had an inconsistent error message for no PK. Now, has proper one.


  • #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.


  • #5050: Updating license text.


  • #4724: Support for Models based on tables that have no primary key. Previously, there was no way to distinguish between a model with no primary key and a model relying on the default. Now, the models auto-generated by the connector advertise whether or not they have primary keys.


  • #4532: Data connectors table methods did not display the proper type for the PK Previously, APIs and flows generated for models based created by data connectors assumed a IDs were of type string. Now, the APIs and flows will use the proper type for the primary key.


  • #4929: Remove unexpected query logging on create.

2.0.0 (deprecated)

  • #4871: Breaking Change: Introduce support $eq, $in and $nin (IN and NOT IN) operators in where query. Previously, when using Model flow-nodes and the auto-generated APIs with the MySQL data connectors, it was not possible to formulate a where clause to return results where the field value is in or not in a list of values. Now the where clause can use $eq, $in and $nin to construct these queries, e.g. { "field": { "$in": ["value1", "value2",...]}}.

    For more information on the Model flow-node and the methods that accept a where clause please see the Model documentation.

    Previously, the MySql data connector returned undefined when query returned no results. Now, it returns an empty array.

1.1.4 (deprecated)

  • #4757: Changed SCM repository and associated internal cleanup.


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: https://support.axway.com/en/auth/general-conditions; 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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.