Interface: TableOperations#
TableOperations.TableOperations
Offer CRUD-style operations on a table.
Table of contents#
Methods#
Methods#
create#
▸ create(records
, options?
): Promise
<MinimalRecord>
Create a record or records.
Parameters#
Name | Type |
---|---|
records |
NewRecord |
options? |
OpOptions |
Returns#
Promise
<MinimalRecord>
▸ create(records
, options?
): Promise
<MinimalRecord[]>
Parameters#
Name | Type |
---|---|
records |
NewRecord [] |
options? |
OpOptions |
Returns#
Promise
<MinimalRecord[]>
destroy#
▸ destroy(recordId
): Promise
<number>
Delete a record or records.
Parameters#
Name | Type |
---|---|
recordId |
number |
Returns#
Promise
<number>
▸ destroy(recordIds
): Promise
<number[]>
Parameters#
Name | Type |
---|---|
recordIds |
number [] |
Returns#
Promise
<number[]>
getTableId#
▸ getTableId(): Promise
<string>
Determine the tableId of the table.
Returns#
Promise
<string>
update#
▸ update(records
, options?
): Promise
<void>
Update a record or records.
Parameters#
Name | Type |
---|---|
records |
Record | Record [] |
options? |
OpOptions |
Returns#
Promise
<void>
upsert#
▸ upsert(records
, options?
): Promise
<void>
Add or update a record or records.
Parameters#
Name | Type |
---|---|
records |
AddOrUpdateRecord | AddOrUpdateRecord [] |
options? |
UpsertOptions |
Returns#
Promise
<void>