Oracle connector

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

Minimum requirements

The following are the supported versions, features, and prerequisites and the approximate memory and disk space requirements.

Supported Versions

  • Oracle 12c


  • Approximately 25 MB

Disk space

  • Approximately 16 MB

Supported features

  • Automatic generation of Models from SQL tables

  • Automatic generation of API for Models

  • Full CRUD operations on tables via Models


This connector requires Oracle Instant Client installed. To install it, please follow the instructions for your environment here: Oracle Instant Client

The connector also depends on the node-oracledb module. In order to properly install the connector, please check the prerequisites here: node-oracledb


To install the Oracle connector, execute the following command:

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

A configuration file is generated for you and placed into the /conf directory of your API Builder project. You should configure this file before starting your service.


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

Option name Type Description
connector string Must be: @axway/api-builder-plugin-dc-oracle
connectString string The database instance connection string. For example: localhost/orcl
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.
connectionPooling boolean Enables connection pooling for better performance, scalability, and resilience. See the Connection pooling for more information. Default: false
poolMax integer The maximum number of connections to which a connection pool can grow. Default: 4
poolMin integer The minimum number of connections a connection pool maintains, even when there is no activity to the target database. Default: 0
poolPingInterval integer The number of seconds that a connection has been idle before it is "pinged" to check the connection is alive. Default: 60
poolTimeout integer The number of seconds after which idle connections (unused in the pool) are terminated. Default: 60
poolIncrement integer The number of connections that are opened whenever a connection request exceeds the number of currently open connections. Default: 1


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 database tables will be listed on the Models tab of the console. Now, you can 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: 'oracle'

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

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

Known issues and limitations

The following are the Oracle connector known issues and limitation:

  • Only supports SQL tables.

For a list of additional known issues and limitations, refer to the API Builder Release Notes.

Related Links