Base class for LoopBack connector. This is more a collection of useful methods for connectors than a super class

Helper function to get nested property definition

Hook to be called by DataSource for defining a model

Hook to be called by DataSource for defining a model property

Disconnect from the connector

Execute a command with given parameters

Generate random id. Each data source model must override this method.

Get connector specific settings for a given model, for example,

{
  "postgresql": {
    "schema": "xyz"
  }
}

Return the DataAccessObject interface implemented by the connector

Look up the data source by model name

Get the id value for the given model

Get the metadata for the connector

Get the model definition by name

Get model property definition

Get types associated with the connector

Get the id index (sequence number, starting from 1)

Get the id property name

Get the id property names

Test if a property is nullable

Check if the connector is for a relational DB

Set the id value for the given model

Base class for connectors that connect to relational databases using SQL

Replace all instances that match the where clause with the given data

Find matching model instances by the filter

Please also note the name all is confusing. Model.find is to find all matching instances while Model.findById is to find an instance by id. On the other hand, Connector.prototype.all implements Model.find while Connector.prototype.find implements Model.findById due to the bad naming convention we inherited from juggling-db.

Alters a table

Build a new SQL statement with pagination support by wrapping the given sql

Recreate the tables for the given models

Perform autoupdate for the given models

Build a list of escaped column names for the given model and fields filter

Build the DELETE FROM SQL statement

Build SQL expression

Build an array of fields for the database operation

Build the SET clause for database replace through update query.

Build the SET clause for database update.

Build INSERT SQL statement

Build the clause for default values if the fields is empty

Build the the INSERT INTO statement

Build the clause to return id values after insert

Build the ORDER BY clause

Map the property type from database to loopback

Build sql for listing schemas

Build the UPDATE statement for replacing

Build an array of fields for the replace database operation

Build a SQL SELECT statement

Build the UPDATE statement

Build the SQL WHERE clause for the where object

Get the column name for the given model property. The column name can be customized at the model property definition level as column or columnName. For example,

"name": {
  "type": "string",
  "mysql": {
    "column": "NAME"
  }
}

Get the escaped column name for a given model property

Get the column metadata for the given model property

Count all model instances by the where filter

Create the data model in MySQL

Create the table for the given model

Delete all matching model instances

Discover database schemas

Discover foreign keys that reference to the primary key of this table

Discover foreign keys for a given table

Discover model definitions

Discover model properties from a table

Discover primary keys for a given table

Drop the table for the given model from the database

Escape the name for the underlying database

Escape the name for the underlying database

Execute a SQL statement with given parameters.

Execute a SQL statement with given parameters

Check if a model instance exists for the given id value

Convert the data from database column to model property

Transform the row data into a model data object

Parse the result for SQL UPDATE/DELETE/INSERT for the number of rows affected

Get the default data type for ID

Discover default schema of a database

Get the default database schema name

Parse the result for SQL INSERT for newly inserted id

Get the place holder in SQL for identifiers, such as ??

Get the place holder in SQL for values, such as :1 or ?

Get the status of a table

Get types associated with the connector Returns {String[]} The types for the connector

Get the id column name.

Get the escaped id column name

Convert the id value to the form required by database column

Invoke a prototype method on the super class

Check if the models exist

Paginate the results returned from database

Replace ? with connector specific placeholders. For example,

{sql: 'SELECT * FROM CUSTOMER WHERE NAME=?', params: ['John']}
==>
{sql: 'SELECT * FROM CUSTOMER WHERE NAME=:1', params: ['John']}

LIMITATION: We don't handle the ? inside escaped values, for example, SELECT * FROM CUSTOMER WHERE NAME='J?hn' will not be parameterized correctly.

Get the corresponding property name for the given column name

Save the model instance into the database

Get the database schema name for the given model. The schema name can be customized at model settings or connector configuration level as schema or schemaName. For example,

"Customer": {
  "name": "Customer",
  "mysql": {
    "schema": "MYDB",
    "table": "CUSTOMER"
  }
}

Serialize an object into JSON string or other primitive types so that it can be saved into a RDB column

Set default options for the connector

Set the nullable value for the property

Get fields from a table

Get indexes from a table

Get the table name for the given model. The table name can be customized at model settings as table or tableName. For example,

"Customer": {
  "name": "Customer",
  "mysql": {
    "table": "CUSTOMER"
  }
}

Returns the table name (String).

Get the escaped table name

Converts a model property value into the form required by the database column. The result should be one of following forms:

• {sql: "point(?,?)", params:[10,20]}
• {sql: "'John'", params: []}
• "John"

Update all instances that match the where clause with the given data

A class for parameterized SQL clauses

Append the statement into the current statement

Join multiple parameterized SQLs into one

Merge the parameterized sqls into the current instance