Interface IQueryBuilder

Class for building a certain type of query (insert / upsert / update / delete / select / find) for an API Connection.

Hierarchy

IQueryBuilder

Index

Methods

Methods

delete

delete(table: string | ITable, filter?: Filter): QueryDelete

Creates a delete query for one or more tables of an API connection.

Parameters
- table: string | ITable
  
  The name of the table to delete the record from.
- Optional filter: Filter
  
  The filter condition for the table.
Returns QueryDelete

find

find(table: string | ITable, filter: Filter, mode?: FindMode): Promise<IBuffer>

Find a record in the table that satisfy the query conditions.

Parameters
- table: string | ITable
  
  The name of the table to select the records from.
- filter: Filter
  
  The filter condition for the table.
- Optional mode: FindMode
Returns Promise<IBuffer>

insert

insert(table: string | ITable, values: Record): QueryInsert

Creates an insert query for one table of an API connection.

since

1.1.0

Parameters
- table: string | ITable
  
  The name of the table to create a new record into.
- values: Record
  
  The field values to set when the query is executed.
Returns QueryInsert

select

select(table: string | ITable, filter?: Filter, offset?: number, limit?: number): QuerySelect

Creates a select query for one or more tables of an API connection.

Parameters
- table: string | ITable
  
  The name of the table to select the records from.
- Optional filter: Filter
  
  The filter condition for the table.
- Optional offset: number
- Optional limit: number
Returns QuerySelect

update

update(table: string | ITable, values: Record, filter?: Filter): QueryUpdate

Creates an update query for one or more tables of an API connection.

since

1.1.0

Parameters
- table: string | ITable
  
  The name of the table to update records from.
- values: Record
- Optional filter: Filter
Returns QueryUpdate

upsert

upsert(table: string | ITable, values: Record): QueryUpsert

Creates an upsert query for one table of an API connection.

since

1.1.0

Parameters
- table: string | ITable
  
  The name of the table to update or create a new record into.
- values: Record
  
  The field values to set when the query is executed.
Returns QueryUpsert