Cluster
in package
implements
ClusterInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $client : Client
- __construct() : mixed
- analyticsQuery() : AnalyticsResult
- bucket() : Bucket
- buckets() : BucketManager
- close() : mixed
- query() : QueryResult
- queryIndexes() : QueryIndexManager
- searchIndexes() : SearchIndexManager
- searchQuery() : SearchResult
Properties
$client
private
Client
$client
Methods
__construct()
public
__construct(string $connectionString[, ClusterOptions $options = new ClusterOptions() ]) : mixed
Parameters
- $connectionString : string
- $options : ClusterOptions = new ClusterOptions()
Return values
mixed —analyticsQuery()
public
analyticsQuery(string $statement[, AnalyticsOptions|null $options = null ]) : AnalyticsResult
Parameters
- $statement : string
- $options : AnalyticsOptions|null = null
Return values
AnalyticsResult —bucket()
public
bucket(string $name) : Bucket
Parameters
- $name : string
Return values
Bucket —buckets()
public
buckets() : BucketManager
Return values
BucketManager —close()
public
close() : mixed
Return values
mixed —query()
public
query(string $statement[, QueryOptions|null $options = null ]) : QueryResult
Parameters
- $statement : string
- $options : QueryOptions|null = null
Tags
Return values
QueryResult —queryIndexes()
public
queryIndexes() : QueryIndexManager
Return values
QueryIndexManager —searchIndexes()
public
searchIndexes() : SearchIndexManager
Return values
SearchIndexManager —searchQuery()
public
searchQuery(string $indexName, SearchQuery $query[, SearchOptions|null $options = null ]) : SearchResult
Parameters
- $indexName : string
- $query : SearchQuery
- $options : SearchOptions|null = null