Interface SaveRowsOptions

Hierarchy

Properties

apiVersion?: string | number

Version of the API. If this is 13.2 or higher, a request that fails validation will be returned as a successful response. Use the 'errorCount' and 'committed' properties in the response to tell if it committed or not. If this is 13.1 or lower (or unspecified), the failure callback will be invoked instead in the event of a validation failure.

commands: Command[]

An array of all of the update/insert/delete operations to be performed.

containerPath?: string

The container path in which the changes are to be performed. If not supplied, the current container path will be used.

extraContext?: any

Experimental: Optional extra context object passed into the transformation/validation script environment. The extraContext at the command-level will be merged with the extraContext at the top-level of the config.

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

scope?: any

A scoping object for the success and failure callback functions (default to this).

This will be called upon successfully completing a request.

timeout?: number

The maximum number of milliseconds to allow for this operation before generating a timeout error (defaults to 30000).

transacted?: boolean

Whether all of the row changes for all of the tables should be done in a single transaction, so they all succeed or all fail. Defaults to true.

validateOnly?: boolean

Whether or not the server should attempt proceed through all of the commands, but not actually commit them to the database. Useful for scenarios like giving incremental validation feedback as a user fills out a UI form, but not actually save anything until they explicitly request a save.

Generated using TypeDoc