PHP Class Phalcon\Db\Adapter\MongoDB\Operation\CreateCollection

See also: MongoDB\Database::createCollection()
See also: http://docs.mongodb.org/manual/reference/command/create/
Inheritance: implements Phalcon\Db\Adapter\MongoDB\Operation\Executable
Show file Open project: phalcon/incubator Class Usage Examples

Public Methods

Method Description
__construct ( string $databaseName, string $collectionName, array $options = [] ) Constructs a create command.
execute ( MongoDB\Driver\Server $server ) : array | object Execute the operation.

Private Methods

Method Description
createCommand ( ) : MongoDB\Driver\Command Create the create command.

Method Details

__construct() public method

Supported options: * autoIndexId (boolean): Specify false to disable the automatic creation of an index on the _id field. For replica sets, this option cannot be false. The default is true. * capped (boolean): Specify true to create a capped collection. If set, the size option must also be specified. The default is false. * flags (integer): Options for the MMAPv1 storage engine only. Must be a bitwise combination CreateCollection::USE_POWER_OF_2_SIZES and CreateCollection::NO_PADDING. The default is CreateCollection::USE_POWER_OF_2_SIZES. * indexOptionDefaults (document): Default configuration for indexes when creating the collection. * max (integer): The maximum number of documents allowed in the capped collection. The size option takes precedence over this limit. * maxTimeMS (integer): The maximum amount of time to allow the query to run. * size (integer): The maximum number of bytes for a capped collection. * storageEngine (document): Storage engine options. * typeMap (array): Type map for BSON deserialization. This will only be used for the returned command result document. * validationAction (string): Validation action. * validationLevel (string): Validation level. * validator (document): Validation rules or expressions.
See also: http://source.wiredtiger.com/2.4.1/struct_w_t___s_e_s_s_i_o_n.html#a358ca4141d59c345f401c58501276bbb
See also: https://docs.mongodb.org/manual/core/document-validation/
public __construct ( string $databaseName, string $collectionName, array $options = [] )
$databaseName string Database name
$collectionName string Collection name
$options array Command options

execute() public method

Execute the operation.
See also: Executable::execute()
public execute ( MongoDB\Driver\Server $server ) : array | object
$server MongoDB\Driver\Server
return array | object Command result document