Class Scope

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

analyticsQuery collection eventingFunctions query search searchIndexes

Accessors

name

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

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

Methods

analyticsQuery

analyticsQuery<TRow = any>(
    statement: string,
    options?: AnalyticsQueryOptions,
    callback?: NodeCallback<AnalyticsResult<TRow>>,
): StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>
Executes an analytics query against the cluster scoped this scope.
Type Parameters
- TRow = any
Parameters
- statement: string
  The analytics statement to execute.
- Optionaloptions: AnalyticsQueryOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<AnalyticsResult<TRow>>
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>
- Defined in lib/scope.ts:164

collection

collection(collectionName: string): Collection
Creates a Collection object reference to a specific collection.
Parameters
- collectionName: string
  The name of the collection to reference.
Returns Collection
- Defined in lib/scope.ts:94

eventingFunctions

eventingFunctions(): ScopeEventingFunctionManager
Returns a ScopeEventingFunctionManager which can be used to manage the eventing functions of this scope. Uncommitted: This API is subject to change in the future.

Returns ScopeEventingFunctionManager
- Defined in lib/scope.ts:115

query

query<TRow = any>(
    statement: string,
    options?: QueryOptions,
    callback?: NodeCallback<QueryResult<TRow>>,
): StreamableRowPromise<QueryResult<TRow>, TRow, QueryMetaData>
Executes a N1QL query against the cluster scoped to this scope.
Type Parameters
- TRow = any
Parameters
- statement: string
  The N1QL statement to execute.
- Optionaloptions: QueryOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<QueryResult<TRow>>
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<QueryResult<TRow>, TRow, QueryMetaData>
- Defined in lib/scope.ts:130

search

search(
    indexName: string,
    request: SearchRequest,
    options?: SearchQueryOptions,
    callback?: NodeCallback<SearchResult>,
): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>
Executes a search query against the scope.
Parameters
- indexName: string
  The name of the index to query.
- request: SearchRequest
  The SearchRequest describing the search to execute.
- Optionaloptions: SearchQueryOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<SearchResult>
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>
- Defined in lib/scope.ts:199

searchIndexes

searchIndexes(): ScopeSearchIndexManager
Returns a SearchIndexManager which can be used to manage the search indexes of this scope.

Returns ScopeSearchIndexManager
- Defined in lib/scope.ts:102