Documentation

Scope
in package
implements ScopeInterface

Scope is an object for providing access to collections.

Interfaces, Classes, Traits and Enums

ScopeInterface
Scope is an object for providing access to collections.

Table of Contents

$bucketName  : string
$core  : resource
$name  : string
analyticsQuery()  : AnalyticsResult
Executes an analytics query against the cluster with scopeName set implicitly.
collection()  : Collection
Returns a new Collection object representing the collection specified.
name()  : string
Returns the name of the scope.
query()  : QueryResult
Executes a N1QL query against the cluster with scopeName set implicitly.
search()  : SearchResult
Executes a search query against the full text search services.
searchIndexes()  : ScopeSearchIndexManagerInterface
Provides access to search index management services at the scope level

Properties

$bucketName

private string $bucketName

$core

private resource $core

Methods

collection()

Returns a new Collection object representing the collection specified.

public collection(string $name) : Collection
Parameters
$name : string

the name of the collection

Tags
since
4.0.0
Return values
Collection

name()

Returns the name of the scope.

public name() : string
Tags
since
4.0.0
Return values
string

Executes a search query against the full text search services.

public search(string $indexName, SearchRequest $request[, SearchOptions|null $options = null ]) : SearchResult

This can be used to perform a traditional FTS query, and/or a vector search.

Parameters
$indexName : string

the scope-level fts index to use for the search request

$request : SearchRequest

The search request to run

$options : SearchOptions|null = null

The options to use when executing the search request

Tags
throws
InvalidArgumentException
since
4.1.7
Return values
SearchResult

        

Search results