Documentation

UpdateSearchIndex
in package

FinalYes

Operation for the createIndexes command.

Tags
see
Collection::updateSearchIndexes()
see
https://mongodb.com/docs/manual/reference/command/updateSearchIndexes/

Table of Contents

Properties

$collectionName  : string
$databaseName  : string
$definition  : object
$name  : string
$options  : array<string|int, mixed>

Methods

__construct()  : mixed
Constructs a createSearchIndexes command.
execute()  : void
Execute the operation.

Properties

Methods

__construct()

Constructs a createSearchIndexes command.

public __construct(string $databaseName, string $collectionName, string $name, array<string|int, mixed>|object $definition[, array{comment?: mixed} $options = [] ]) : mixed
Parameters
$databaseName : string

Database name

$collectionName : string

Collection name

$name : string

Search index name

$definition : array<string|int, mixed>|object

Atlas Search index definition

$options : array{comment?: mixed} = []

Command options

Tags
throws
InvalidArgumentException

for parameter parsing errors

execute()

Execute the operation.

public execute(Server $server) : void
Parameters
$server : Server
Tags
throws
UnsupportedException

if write concern is used and unsupported

throws
RuntimeException

for other driver errors (e.g. connection errors)


        
On this page

Search results