Class Scope

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

Hierarchy

Scope

Index

Accessors

name

Methods

Accessors

name

get name(): string

- Defined in lib/scope.ts:75
The name of the scope this Scope object references.

Returns string

Methods

analyticsQuery

analyticsQuery<TRow>(statement: string, options?: AnalyticsQueryOptions, callback?: NodeCallback<AnalyticsResult<TRow>>): StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>

- Defined in lib/scope.ts:129
Executes an analytics query against the cluster scoped this scope.

Type parameters
- TRow = any
Parameters
- statement: string
  
  The analytics statement to execute.
- Optional options: AnalyticsQueryOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<AnalyticsResult<TRow>>
  
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>

collection

collection(collectionName: string): Collection

- Defined in lib/scope.ts:84
Creates a Collection object reference to a specific collection.

Parameters
- collectionName: string
  
  The name of the collection to reference.
Returns Collection

query

query<TRow>(statement: string, options?: QueryOptions, callback?: NodeCallback<QueryResult<TRow>>): StreamableRowPromise<QueryResult<TRow>, TRow, QueryMetaData>

- Defined in lib/scope.ts:95
Executes a N1QL query against the cluster scoped to this scope.

Type parameters
- TRow = any
Parameters
- statement: string
  
  The N1QL statement to execute.
- Optional options: QueryOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<QueryResult<TRow>>
  
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<QueryResult<TRow>, TRow, QueryMetaData>

Generated using TypeDoc