PHP Class Phalcon\Db\Adapter\MongoDB\Database

__construct() public method

This class provides methods for database-specific operations and serves as a gateway for accessing collections. Supported options: * readConcern (MongoDB\Driver\ReadConcern): The default read concern to use for database operations and selected collections. Defaults to the Manager's read concern. * readPreference (MongoDB\Driver\ReadPreference): The default read preference to use for database operations and selected collections. Defaults to the Manager's read preference. * typeMap (array): Default type map for cursors and BSON documents. * writeConcern (MongoDB\Driver\WriteConcern): The default write concern to use for database operations and selected collections. Defaults to the Manager's write concern.

public __construct ( MongoDB\Driver\Manager $manager, string $databaseName, array $options = [] )
$manager	MongoDB\Driver\Manager	Manager instance from the driver
$databaseName	string	Database name
$options	array	Database options

__debugInfo() public method

Return internal properties for debugging purposes.

public __debugInfo ( ) : array
return	array

__get() public method

Note: collections whose names contain special characters (e.g. ".") may be selected with complex syntax (e.g. $database->{"system.profile"}) or {@link selectCollection()}.

public __get ( string $collectionName ) : Collection
$collectionName	string	Name of the collection to select
return	Collection

__toString() public method

Return the database name.

public __toString ( ) : string
return	string

command() public method

Execute a command on this database.

public command ( array | object $command, array $options = [] ) : MongoDB\Driver\Cursor
$command	array | object	Command document
$options	array	Options for command execution
return	MongoDB\Driver\Cursor

createCollection() public method

Create a new collection explicitly.

public createCollection ( string $collectionName, array $options = [] ) : array | object
$collectionName	string
$options	array
return	array | object	Command result document

drop() public method

Drop this database.

public drop ( array $options = [] ) : array | object
$options	array	Additional options
return	array | object	Command result document

dropCollection() public method

Drop a collection within this database.

public dropCollection ( string $collectionName, array $options = [] ) : array | object
$collectionName	string	Collection name
$options	array	Additional options
return	array | object	Command result document

getDatabaseName() public method

Returns the database name.

public getDatabaseName ( ) : string
return	string

listCollections() public method

Returns information for all collections in this database.

public listCollections ( array $options = [] ) : Phalcon\Db\Adapter\MongoDB\Model\CollectionInfoIterator
$options	array
return	Phalcon\Db\Adapter\MongoDB\Model\CollectionInfoIterator

selectCollection() public method

Select a collection within this database.

public selectCollection ( string $collectionName, array $options = [] ) : Collection
$collectionName	string	Name of the collection to select
$options	array	Collection constructor options
return	Collection

withOptions() public method

Get a clone of this database with different options.

public withOptions ( array $options = [] ) : Database
$options	array	Database constructor options
return	Database