Class Scope

Volatile: This API is subject to change at any time.

Exposes the operations which are available to be performed against a scope. Namely, the ability to access to Collections for performing operations.

Index

Accessors

Methods

executeQuery startQuery

Accessors

name

get name(): string
The name of the scope this Scope object references.

Returns string
- Defined in lib/scope.ts:128

Methods

executeQuery

executeQuery(statement: string, options?: QueryOptions): Promise<QueryResult>
Executes a query against the Analytics scope.
Parameters
- statement: string
  The Analytics SQL++ statement to execute.
- Optionaloptions: QueryOptions
  Optional parameters for this operation.
Returns Promise<QueryResult>
- Defined in lib/scope.ts:70

startQuery

startQuery(statement: string, options?: StartQueryOptions): Promise<QueryHandle>
Starts an asynchronous query against the Analytics cluster. Returns a QueryHandle that can be used to fetch results, and cancel the query.
Parameters
- statement: string
  The Analytics SQL++ statement to execute.
- Optionaloptions: StartQueryOptions
  Optional parameters for this operation.
Returns Promise<QueryHandle>
- Defined in lib/scope.ts:101