MongoIndexHelper

Creates indexes or anything like that at deploy time.

trait MongoIndexHelper

use MongoHelper

Requires the mongodb/mongodb composer package to be installed.

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Methods

Protected
Returns	Signature and Description
`ConstVector`<`string`>	`createIndexes`(`Manager $manager`, `string $db`, `string $collection`, `ConstVector<MongoIndex> $indexes`) Creates some indexes in a collection.
`ConstVector`<`mixed`>	`dropIndexes`(`Manager $manager`, `string $db`, `string $collection`, `ConstSet<string> $names`) Deletes some indexes in a collection.
`Ta`	`ensure`<`Ta`>(`mixed $id`, `?Ta $document`) Makes sure a document isn't null.
`UTCDateTime`	`now`() Gets the current time.
`?UTCDateTime`	`toDate`(`mixed $date`) Tries to parse a date.
`ObjectID`	`toId`(`mixed $id`) Transforms a literal into a MongoDB ObjectId.
`ConstVector`<`ObjectID`>	`toIds`(`ConstVector<mixed> $ids`) Transforms literals into MongoDB ObjectIds.

Method Details

createIndexes

protected function createIndexes(Manager $manager, string $db, string $collection, ConstVector<MongoIndex> $indexes)

Creates some indexes in a collection.

See: https://docs.mongodb.com/manual/reference/command/createIndexes/

Parameters
Name	Type	Description
`$manager`	`Manager`	The MongoDB manager
`$db`	`string`	The database name
`$collection`	`string`	The collection name
`$indexes`	`ConstVector`<`MongoIndex`>	The indexes to create

Returns
Type	Description
`ConstVector`<`string`>	The names of the created indexes

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the document doesn't exist
`Violating`	If a constraint is violated
`Inoperable`	If an API is used incorrectly
`Generic`	If any other database problem occurs

dropIndexes

protected function dropIndexes(Manager $manager, string $db, string $collection, ConstSet<string> $names)

Deletes some indexes in a collection.

This method will first check for the existence of the supplied indexes and if found, will drop them.

See: https://docs.mongodb.com/manual/reference/command/dropIndexes/

Parameters
Name	Type	Description
`$manager`	`Manager`	The MongoDB manager
`$db`	`string`	The database name
`$collection`	`string`	The collection name
`$names`	`ConstSet`<`string`>

Returns
Type	Description
`ConstVector`<`mixed`>	The names of the created indexes

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the document doesn't exist
`Violating`	If a constraint is violated
`Inoperable`	If an API is used incorrectly
`Generic`	If any other database problem occurs

ensure

Inherited from MongoHelper

protected function ensure<Ta>(mixed $id, ?Ta $document)

Makes sure a document isn't null.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier, either a `\MongoDB\BSON\ObjectID` or string
`$document`	`?Ta`	The document to check

Returns
Type	Description
`Ta`	Returns `$document`

Throws
Type	Conditions
`Unretrievable`	if the document is null

now

Inherited from MongoHelper

protected function now()

Gets the current time.

Returns
Type	Description
`UTCDateTime`	The current time

toDate

Inherited from MongoHelper

protected function toDate(mixed $date)

Tries to parse a date.

Parameters
Name	Type	Description
`$date`	`mixed`	The possible string date value, a string, a `\DateTimeInterface`, or a `\MongoDB\BSON\UTCDateTime`

Returns
Type	Description
`?UTCDateTime`	The MongoDB datetime or null

toId

Inherited from MongoHelper

protected function toId(mixed $id)

Transforms a literal into a MongoDB ObjectId.

Parameters
Name	Type	Description
`$id`	`mixed`	If it's an `ObjectID`, returns that, otherwise creates a new `ObjectID`.

Returns
Type	Description
`ObjectID`	The ObjectID

toIds

Inherited from MongoHelper

protected function toIds(ConstVector<mixed> $ids)

Transforms literals into MongoDB ObjectIds.

Parameters
Name	Type	Description
`$ids`	`ConstVector`<`mixed`>	Goes through each entry, converts to `ObjectID`

Returns
Type	Description
`ConstVector`<`ObjectID`>	The ObjectIDs