Interface QueryRequestOptions

interface QueryRequestOptions {
    apiVersion?: string | number;
    auditBehavior?: AuditBehaviorTypes;
    auditUserComment?: string;
    autoFormFileData?: boolean;
    containerPath?: string;
    extraContext?: any;
    failure?: RequestFailure<any>;
    form?: FormData | HTMLFormElement;
    queryName: string;
    rowDataArray?: any[];
    rows?: any[];
    schemaName: string;
    scope?: any;
    skipReselectRows?: boolean;
    success?: RequestSuccess<any>;
    timeout?: number;
    transacted?: boolean;
}

Hierarchy (view full)

Properties

apiVersion? auditBehavior? auditUserComment? autoFormFileData? containerPath? extraContext? failure? form? queryName rowDataArray? rows? schemaName scope? skipReselectRows? success? timeout? transacted?

Properties

OptionalapiVersion

apiVersion?: string | number

OptionalauditBehavior

auditBehavior?: AuditBehaviorTypes

Can be used to override the audit behavior for the table the query is acting on. See AuditBehaviorTypes.

OptionalauditUserComment

auditUserComment?: string

Can be used to provide a comment from the user that will be attached to certain detailed audit log records.

OptionalautoFormFileData

autoFormFileData?: boolean

Flag that specifies if row data should be parsed and transformed into FormData when File data is present. Defaults to false. This is useful for endpoints that support File data. The client-side supports parsing and transforming the request payload into FormData for handling File data.

OptionalcontainerPath

containerPath?: string

The container path in which the schema and query name are defined. If not supplied, the current container path will be used.

OptionalextraContext

extraContext?: any

Experimental: Optional extra context object passed into the transformation/validation script environment.

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optionalform

form?: FormData | HTMLFormElement

FormData or Object consumable by FormData that can be used to POST key/value pairs of form information. For more information, see FormData documentation. Note that if both form and rows are provided, the form object will be used.

queryName

queryName: string

Name of a query table associated with the chosen schema. See also: How To Find schemaName, queryName & viewName.

OptionalrowDataArray

rowDataArray?: any[]

Optionalrows

rows?: any[]

Array of record objects in which each object has a property for each field. The row data array needs to include only the primary key column value, not all columns. Note that if both form and rows are provided, the form object will be used.

schemaName

schemaName: string

Name of a schema defined within the current container. See also: How To Find schemaName, queryName & viewName.

Optionalscope

scope?: any

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

OptionalskipReselectRows

skipReselectRows?: boolean

Whether the full detailed response for the update/insert rows can be skipped. Defaults to false.

Optionalsuccess

success?: RequestSuccess<any>

This will be called upon successfully completing a request.

Optionaltimeout

timeout?: number

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

Optionaltransacted

transacted?: boolean

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

Settings

Member Visibility

On This Page

Properties