Skip to main content

mysql@1.4.14

Functions

insert(table, fields)
query(options)
sqlString(queryString)
upsert(table, fields)
upsertMany(table, data)

The following functions are exported from the common adaptor:

alterState()
arrayToString()
combine()
dataPath()
dataValue()
each()
field()
fields()
fn()
http()
lastReferenceValue()
merge()
sourceValue()

insert

insert(table, fields) ⇒ Operation

Insert a record

ParamTypeDescription
tablestringThe target table
fieldsobjectA fields object

Example

execute(
insert('table', fields(
field('name', dataValue('name'))
))
)(state)

query

query(options) ⇒ Operation

Execute a SQL statement

ParamTypeDescription
optionsobjectPayload data for the message

Example

execute(
query({ sql: 'select * from users;' })
)(state)

sqlString

sqlString(queryString) ⇒ Operation

Execute a SQL statement

ParamTypeDescription
queryStringStringA query string (or function which takes state and returns a string)

Example

execute(
sqlString(state => "select * from items;")
)(state)

upsert

upsert(table, fields) ⇒ Operation

Insert or Update a record if matched

ParamTypeDescription
tablestringThe target table
fieldsobjectA fields object

Example

execute(
upsert('table', fields(
field('name', dataValue('name'))
))
)(state)

upsertMany

upsertMany(table, data) ⇒ Operation

Insert or update multiple records using ON DUPLICATE KEY

ParamTypeDescription
tablestringThe target table
dataarrayAn array of objects or a function that returns an array

Example

upsertMany(
'users', // the DB table
[
{ name: 'one', email: 'one@openfn.org' },
{ name: 'two', email: 'two@openfn.org' },
]
)