MongoRepository

MMO\mongodb · 1 symbol · generated 5 Oct 2026

class

MongoRepository

Mongodb bridge

class MMO\mongodb\MongoRepository extends MMO\core\classes\aRepository

Namespace: MMO\mongodb
Extends: aRepository

NOTE: as pagination makes queries a lot slower, it is only activated if the query offset is set to something (0 or anything else). an offset null means the pagination won't be activated.

Index

	AUTO_TEXT_INDEX
	backupFolder
	database
	handle readonly
	lock
	refs
	uri readonly
	url
	autoTextIndexes($options)
	backup($filename, $database, $shell, $remoteFile)	Backup database in a mongo specific archive
	collectionExists($name, $database)	Check if a collection exists
	createCursor($collection, $filter, $options)	Create a mongo cursor from a simple filter.
	createEntity($class, $data, $collection)
	createIndex($collection, $keys, $unique, $name, $options)	Create an index on one/multiple keys
	createIndexes($collection, $indexes, $options)	Create multiple indexes
	createPipelineCursor($collection, $pipeline, $options)	Create a mongo cursor from a pipeline.
	createReadCommand($command, $options)
	debugName()
	doResolution()
	dropAutoTextIndexes()
	dropCollection($collection, $opts)
	dropDatabase($database, $opts)
	dropIndexes($collection, $names)
	executeCustomQuery($collection, $filter, $options, $raw, $reload)	Execute a custom query and return the entities, resolving inner references
	executeQuery($query, $opts)	Execute a query and return the entities, resolving inner references.
	ExtractDatabaseFromName($filename) static
	getBackupFolder()
	getBackupName($date, $database)
	getDatabases()
	getDistinct($collection, $key, $database)
	getTemplateTextKeys($indexes, $schema, $template)
	hasIndex($collection, $name)
	isLockResolution()
	listCollections($database)
	listIndexes($collection)
	loadEntities($collection, $cursor, $reload)	Load entities from a cursor, resolving inner references
	lockResolution()
	loopIndexes($collection)
	onCommit($commit)	Save the entities of this commit that belong to this repository: one bulk write per collection.
	patch($database, $patch, $shell)
	resolveReferences($data, $reload)
	restore($filename, $database, $collections, $shell, $oldDatabase, $drop)	Restore backup from zip\|tar archive
	searchText($query, $text, $_hashes)
	selectServer($mode)	https://www.mongodb.com/docs/manual/core/read-preference/ selon le tableau, pour les updates multi-doc il faut rester sur primary Peut-être faire les lectures sur les replicats et les écritures sur…
	uid()
	unlockResolution()
	__construct($uri, $database, $collections)
	__wakeup()

Constants1

AUTO_TEXT_INDEX

const AUTO_TEXT_INDEX = 'mmo_auto_text_index'

Properties7

backupFolder

string $backupFolder = '{root}/db/backups'

Type: string

database

string $database

Type: string

handle

readonly

#[MMO\core\attributes\Serialize(false)] readonly MongoDB\Driver\Manager $handle

Type: Manager

lock

protected int $lock = 0

Type: int

refs

protected array $refs = []

Type: array

uri

readonly

readonly string $uri

Type: string

url

string $url = 'mongodb://127.0.0.1'

Type: string

Methods40

autoTextIndexes($options)

MongoRepository.php:443

function autoTextIndexes(array $options = []): array

$options = []	array
returns	array

backup($filename, $database, $shell, $remoteFile)

MongoRepository.php:97

Backup database in a mongo specific archive

function backup( ?string $filename = null, ?string $database = null, ?MMO\core\interfaces\iShell $shell = null, ?string $remoteFile = null ): string

$filename = null	null \| string	(absolute or relative) an archive name
$database = null	null \| string
$shell = null	null \| iShell	the shell to use for the execution of command
$remoteFile = null	null \| string	(only if shell is remote) the remote file to save the archive into. if null, save it to tmp folder
returns	string	the filename of the archive

collectionExists($name, $database)

MongoRepository.php:288

Check if a collection exists

function collectionExists(string $name, ?string $database = null): bool

$name	string
$database = null	null \| string
returns	bool
throws

createCursor($collection, $filter, $options)

MongoRepository.php:540

Create a mongo cursor from a simple filter.

function createCursor( MMO\core\interfaces\iCollection|string $collection, array $filter, array $options = [] ): MongoDB\Driver\Cursor

NOTE: does not resolve inner references.

$collection	iCollection \| string
$filter	array
$options = []	array
returns	Cursor

createEntity($class, $data, $collection)

MongoRepository.php:172

function createEntity( string $class, array $data = [], ?MMO\core\interfaces\iCollection $collection = null ): MMO\core\interfaces\iEntity

$class	string
$data = []	array
$collection = null	null \| iCollection
returns	iEntity

createIndex($collection, $keys, $unique, $name, $options)

MongoRepository.php:394

Create an index on one/multiple keys

function createIndex( MMO\core\interfaces\iCollection|string $collection, array $keys, bool $unique = false, ?string $name = null, array $options = [] ): void

See: https://www.mongodb.com/docs/php-library/current/reference/method/MongoDBCollection-createIndex/#mongodb-phpmethod-phpmethod.MongoDB-Collection--createIndex--

$collection	iCollection \| string
$keys	array	{key: {xxx: 1\|-1\|text}}
$unique = false	bool
$name = null	null \| string
$options = []	array
returns	void

createIndexes($collection, $indexes, $options)

MongoRepository.php:377

Create multiple indexes

function createIndexes( MMO\core\interfaces\iCollection|string $collection, array $indexes, array $options = [] ): void

$collection	iCollection \| string
$indexes	array	[{key: {xxx: 1\|-1\|text}, unique: bool, partialFilterExpression: {}, name: xxx}
$options = []	array
returns	void

createPipelineCursor($collection, $pipeline, $options)

MongoRepository.php:571

Create a mongo cursor from a pipeline.

function createPipelineCursor( MMO\core\interfaces\iCollection|string $collection, array $pipeline, array $options = [] ): MongoDB\Driver\Cursor

NOTE: does not resolve inner references.

$collection	iCollection \| string
$pipeline	array
$options = []	array
returns	Cursor

createReadCommand($command, $options)

MongoRepository.php:549

function createReadCommand(array $command, array $options = []): MongoDB\Driver\Cursor

$command	array
$options = []	array
returns	Cursor

debugName()

MongoRepository.php:60

function debugName(): string

returns

string

doResolution()

MongoRepository.php:243

function doResolution(): void

returns

void

dropAutoTextIndexes()

MongoRepository.php:475

function dropAutoTextIndexes(): void

returns

void

dropCollection($collection, $opts)

MongoRepository.php:305

function dropCollection(MMO\core\interfaces\iCollection|string $collection, array $opts = []): bool

$collection	iCollection \| string
$opts = []	array
returns	bool

dropDatabase($database, $opts)

MongoRepository.php:324

function dropDatabase(?string $database = null, array $opts = []): void

$database = null	null \| string
$opts = []	array
returns	void

dropIndexes($collection, $names)

MongoRepository.php:416

function dropIndexes(MMO\core\interfaces\iCollection|string $collection, string ...$names): void

$collection	iCollection \| string
...$names	string
returns	void

executeCustomQuery($collection, $filter, $options, $raw, $reload)

MongoRepository.php:665

Execute a custom query and return the entities, resolving inner references

function executeCustomQuery( MMO\core\interfaces\iCollection|string $collection, array $filter, array $options = [], bool $raw = false, bool $reload = false ): array

$collection	iCollection \| string
$filter	array
$options = []	array
$raw = false	bool	if true, will not load entities or resolve references
$reload = false	bool	if true, will load the data, even if the entity is already locally loaded
returns	array

executeQuery($query, $opts)

MongoRepository.php:631

Execute a query and return the entities, resolving inner references.

function executeQuery(MMO\core\entities\Query $query, array $opts = []): array

WARNING: called by the Query to retrieve entities. Don't call directly. Use the query instead.

$query	Query
$opts = []	array	options to pass to the execution -raw: bool if true, will return array instead of entities
returns	array

ExtractDatabaseFromName($filename)

staticMongoRepository.php:72

static function ExtractDatabaseFromName(string $filename): ?string

$filename	string
returns	null \| string

getBackupFolder()

MongoRepository.php:64

function getBackupFolder(): string

returns

string

getBackupName($date, $database)

MongoRepository.php:68

function getBackupName(DateTimeInterface|int|null $date = null, ?string $database = null): string

$date = null	DateTimeInterface \| int \| null
$database = null	null \| string
returns	string

getDatabases()

MongoRepository.php:332

function getDatabases(): array

returns

array

getDistinct($collection, $key, $database)

MongoRepository.php:300

function getDistinct(string $collection, string $key, ?string $database = null): array

$collection	string
$key	string
$database = null	null \| string
returns	array

getTemplateTextKeys($indexes, $schema, $template)

MongoRepository.php:427

protected function getTemplateTextKeys(array &$indexes, MMO\core\schemas\Schema $schema, string $template): void

$indexes	array
$schema	Schema
$template	string
returns	void

hasIndex($collection, $name)

MongoRepository.php:361

function hasIndex(MMO\core\interfaces\iCollection|string $collection, string $name): bool

$collection	iCollection \| string
$name	string
returns	bool

isLockResolution()

MongoRepository.php:239

function isLockResolution(): bool

returns

bool

listCollections($database)

MongoRepository.php:293

function listCollections(?string $database = null): array

$database = null	null \| string
returns	array

listIndexes($collection)

MongoRepository.php:357

function listIndexes(MMO\core\interfaces\iCollection|string $collection): array

$collection	iCollection \| string
returns	array

loadEntities($collection, $cursor, $reload)

MongoRepository.php:677

Load entities from a cursor, resolving inner references

function loadEntities( MMO\core\interfaces\iCollection $collection, iterable $cursor, bool $reload = false ): array

$collection	iCollection
$cursor	iterable
$reload = false	bool
returns	array

lockResolution()

MongoRepository.php:225

function lockResolution(): void

returns

void

loopIndexes($collection)

MongoRepository.php:344

function loopIndexes(MMO\core\interfaces\iCollection|string $collection): Generator

$collection	iCollection \| string
returns	Generator

onCommit($commit)

MongoRepository.php:710

Save the entities of this commit that belong to this repository: one bulk write per collection. An entity removed leaves its collection; one created and removed before being saved is neither deleted nor inserted.

function onCommit(MMO\core\events\Commit $commit): void

NOTE: until 2026-09 an entity removed stayed in its collection ([`Collection::getById`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/Collection.md#collection-getbyid) found it), and one created and removed before being saved was inserted by the next commit.

$commit	Commit
returns	void

\MMO\commit($this); // dispatches the Commit this answers

patch($database, $patch, $shell)

MongoRepository.php:81

function patch( string $database, string $patch, ?MMO\core\interfaces\iShell $shell = null ): string

$database	string
$patch	string
$shell = null	null \| iShell
returns	string

resolveReferences($data, $reload)

MongoRepository.php:185

function resolveReferences(array $data, bool $reload = false): MMO\core\interfaces\iEntity|array|null

$data	array
$reload = false	bool
returns	iEntity \| array \| null

restore($filename, $database, $collections, $shell, $oldDatabase, $drop)

MongoRepository.php:127

Restore backup from zip|tar archive

function restore( DateTimeInterface|string|int $filename, ?string $database = null, ?array $collections = null, ?MMO\core\interfaces\iShell $shell = null, ?string $oldDatabase = null, bool $drop = true ): void

$filename	DateTimeInterface \| string \| int	the filename of the archive. If not a string, use `getBackupFolder` and `getBackupName` to make it.
$database = null	null \| string
$collections = null	null \| array	a list of collections to restore
$shell = null	null \| iShell	the shell to use for the execution of command
$oldDatabase = null	null \| string	the database's name that has been dump in the archive (you dump database 'test'(oldDatabase) but want to restore it in 'demo'(database).)
$drop = true	bool
returns	void

searchText($query, $text, $_hashes)

MongoRepository.php:482

function searchText( MMO\core\interfaces\iCollection|MMO\core\entities\Query|string $query, string $text, array &$_hashes = [] ): array

$query	iCollection \| Query \| string
$text	string
$_hashes = []	array
returns	array

selectServer($mode)

MongoRepository.php:278

https://www.mongodb.com/docs/manual/core/read-preference/ selon le tableau, pour les updates multi-doc il faut rester sur primary Peut-être faire les lectures sur les replicats et les écritures sur le primary ? Ca donnerait : --- pour le bulk return $this->handle->selectServer(new ReadPreference(ReadPreference::PRIMARY)); --- pour le find (voir si le temps de réplication peut impacter le métier) return $this->handle->selectServer(new ReadPreference(ReadPreference::SECONDARY_PREFERRED)); ou alors (à tester sur un cluster peut-être ?) return $this->handle->selectServer(new ReadPreference(ReadPreference::NEAREST));

function selectServer(?string $mode = MongoDB\Driver\ReadPreference::NEAREST): MongoDB\Driver\Server

$mode = MongoDB\Driver\ReadPreference::NEAREST	null \| string
returns	Server

uid()

MongoRepository.php:77

function uid(): string

returns

string

unlockResolution()

MongoRepository.php:229

function unlockResolution(): bool

returns

bool

__construct($uri, $database, $collections)

MongoRepository.php:49

function __construct(string $uri, string $database, array $collections = [])

$uri	string
$database	string
$collections = []	array

__wakeup()

MongoRepository.php:55

function __wakeup(): void

returns

void

Inherited members (23)

	Properties	Declared by	Description
	`collections`	aRepository

Methods	Declared by	Description
`addCollection($name, $collection)`	aRepository	Add collection
`createCollection($name, $entityClass, $collectionId)`	aRepository	Create and register a plain `Collection` for entities of $entityClass.
`createLog($type, $origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Build (but not dispatch) a `LogQuery` entity describing a data-mutating operation, stored in the repository's LogQuery collection (if one is registered).
`forceCommit($origin, $entities)`	aRepository
`getCollection($name)`	aRepository
`getCollectionByClass($entityClass, $allowChildClass)`	aRepository	Find the collection whose entities are (an exact match, or optionally a subclass of) $entityClass.
`getCollectionName($collection)`	aRepository
`getCollections()`	aRepository
`getEntities()`	aRepository
`getIterator()`	aRepository	\IteratorAggregate::getIterator -- iterates name => iCollection
`hasCollection($collection)`	aRepository
`hideLogData($collection, $data)`	aRepository	What a repository logs is what it wrote (mmo.pdo's row, mmo.mongodb's document or its changes), hidden properties (`ArrayProperty::isHidden`) included, and a log is exported…
`logDelete($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch a DELETE operation.
`logInsert($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch an INSERT operation.
`logStatus($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch a STATUS-change operation.
`logUpdate($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch an UPDATE operation.
`offsetExists($key)`	aRepository	\ArrayAccess::offsetExists
`offsetGet($key)`	aRepository	\ArrayAccess::offsetGet
`offsetSet($key, $value)`	aRepository	\ArrayAccess::offsetSet -- equivalent to `addCollection`
`offsetUnset($key)`	aRepository	\ArrayAccess::offsetUnset
`onFetch($event)`	aRepository	Listener for `Fetch`: resolves a `repository-uid/collection-id#id` (or `repository-uid/collection-id#id/nested/path` for an embedded value) URL, what `Ent…`
`setCollections($cols)`	aRepository	Register a batch of collections at once, e.g.