Documentation

CreateCollection
in package
implements Executable

Operation for the create command.

Tags
see
Database::createCollection()
see
http://docs.mongodb.org/manual/reference/command/create/

Interfaces, Classes, Traits and Enums

Executable

Table of Contents

NO_PADDING  = 2
USE_POWER_OF_2_SIZES  = 1
$collectionName  : string
$databaseName  : string
$options  : array<string|int, mixed>
__construct()  : mixed
Constructs a create command.
execute()  : array<string|int, mixed>|object
Execute the operation.
createCommand()  : Command
Create the create command.
createOptions()  : array<string|int, mixed>
Create options for executing the command.

Constants

Properties

Methods

__construct()

Constructs a create command.

public __construct(string $databaseName, string $collectionName[, array<string|int, mixed> $options = [] ]) : mixed

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.

    This option has been deprecated since MongoDB 3.2. As of MongoDB 4.0, this option cannot be false when creating a replicated collection (i.e. a collection outside of the local database in any mongod mode).

  • capped (boolean): Specify true to create a capped collection. If set, the size option must also be specified. The default is false.

  • collation (document): Collation specification.

  • expireAfterSeconds: The TTL for documents in time series collections.

    This is not supported for servers versions < 5.0.

  • 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.

  • session (MongoDB\Driver\Session): Client session.

  • size (integer): The maximum number of bytes for a capped collection.

  • storageEngine (document): Storage engine options.

  • timeseries (document): Options for time series collections.

    This is not supported for servers versions < 5.0.

  • 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.

  • writeConcern (MongoDB\Driver\WriteConcern): Write concern.

Parameters
$databaseName : string

Database name

$collectionName : string

Collection name

$options : array<string|int, mixed> = []

Command options

Tags
see
http://source.wiredtiger.com/2.4.1/struct_w_t___s_e_s_s_i_o_n.html#a358ca4141d59c345f401c58501276bbb
see
https://docs.mongodb.org/manual/core/document-validation/
throws
InvalidArgumentException

for parameter/option parsing errors

Return values
mixed —

execute()

Execute the operation.

public execute(Server $server) : array<string|int, mixed>|object
Parameters
$server : Server
Tags
see
Executable::execute()
throws
RuntimeException

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

Return values
array<string|int, mixed>|object —

Command result document

createCommand()

Create the create command.

private createCommand() : Command
Return values
Command —

Search results