ListSearchIndexes
in package
FinalYes
Operation for the listSearchIndexes command.
Tags
Table of Contents
Properties
- $aggregate : Aggregate
- $aggregateOptions : array<string|int, mixed>
- $collectionName : string
- $databaseName : string
- $listSearchIndexesOptions : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructs an aggregate command for listing Atlas Search indexes
- execute() : Iterator|Countable
- Execute the operation.
- createAggregate() : Aggregate
Properties
$aggregate
private
Aggregate
$aggregate
$aggregateOptions
private
array<string|int, mixed>
$aggregateOptions
$collectionName
private
string
$collectionName
$databaseName
private
string
$databaseName
$listSearchIndexesOptions
private
array<string|int, mixed>
$listSearchIndexesOptions
Methods
__construct()
Constructs an aggregate command for listing Atlas Search indexes
public
__construct(string $databaseName, string $collectionName[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $databaseName : string
-
Database name
- $collectionName : string
-
Collection name
- $options : array<string|int, mixed> = []
-
Command options
execute()
Execute the operation.
public
execute(Server $server) : Iterator|Countable
Parameters
- $server : Server
Tags
Return values
Iterator|CountablecreateAggregate()
private
createAggregate() : Aggregate