CreateSearchIndexes
in package
FinalYes
Operation for the createIndexes command.
Tags
Table of Contents
Properties
- $collectionName : string
- $databaseName : string
- $indexes : array<string|int, mixed>
- $options : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructs a createSearchIndexes command.
- execute() : array<string|int, string>
- Execute the operation.
Properties
$collectionName
private
string
$collectionName
$databaseName
private
string
$databaseName
$indexes
private
array<string|int, mixed>
$indexes
= []
$options
private
array<string|int, mixed>
$options
Methods
__construct()
Constructs a createSearchIndexes command.
public
__construct(string $databaseName, string $collectionName, array<string|int, array<string|int, mixed>> $indexes, array{comment?: mixed} $options) : mixed
Parameters
- $databaseName : string
-
Database name
- $collectionName : string
-
Collection name
- $indexes : array<string|int, array<string|int, mixed>>
-
List of search index specifications
- $options : array{comment?: mixed}
-
Command options
Tags
execute()
Execute the operation.
public
execute(Server $server) : array<string|int, string>
Parameters
- $server : Server
Tags
Return values
array<string|int, string> —The names of the created indexes