Interface GetQueryDetailsOptions

interface GetQueryDetailsOptions {
    containerPath?: string;
    failure?: RequestFailure<any>;
    fields?: string | string[];
    fk?: string;
    includeTriggers?: boolean;
    initializeMissingView?: boolean;
    method?: "GET" | "POST";
    queryName: string;
    schemaName: string;
    scope?: any;
    success?: RequestSuccess<QueryDetailsResponse>;
    viewName?: string | string[];
}

Hierarchy (view full)

Properties

containerPath? failure? fields? fk? includeTriggers? initializeMissingView? method? queryName schemaName scope? success? viewName?

Properties

Optional containerPath

containerPath?: string

A container path in which to execute this command. If not supplied, the current container will be used.

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optional fields

fields?: string | string[]

A field key or Array of field keys to include in the metadata.

Optional fk

fk?: string

When specified the response will only include columns from the specified foreign key query.

Optional includeTriggers

includeTriggers?: boolean

Include trigger metadata in the response.

Optional initializeMissingView

initializeMissingView?: boolean

Initialize the view based on the default view iff the view doesn't yet exist.

Optional method

method?: "GET" | "POST"

Specify the HTTP method to use when making the request. Defaults to GET.

queryName

queryName: string

The name of the query.

schemaName

schemaName: string

The name of the schema.

Optional scope

scope?: any

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

Optional success

success?: RequestSuccess<QueryDetailsResponse>

This will be called upon successfully completing a request.

Optional viewName

viewName?: string | string[]

A view name or Array of view names to include custom view details. Use '*' to include all views for the query.

Settings

Member Visibility

Theme

On This Page

containerPathfailurefieldsfkincludeTriggersinitializeMissingViewmethodqueryNameschemaNamescopesuccessviewName

Generated using TypeDoc