MongoDB\Operation\CreateCollection Class Reference

Inheritance diagram for MongoDB\Operation\CreateCollection:

Public Member Functions
	__construct (string $databaseName, string $collectionName, array $options=[])
	Constructs a create command.
	execute (Server $server)
	Execute the operation.

Public Attributes
const	NO_PADDING = 2
const	USE_POWER_OF_2_SIZES = 1

Constructor & Destructor Documentation

__construct()

MongoDB\Operation\CreateCollection::__construct	(	string	$databaseName,
		string	$collectionName,
		array	$options = [] )

Constructs a create command.

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.

• comment (mixed): BSON value to attach as a comment to this command.

  This is not supported for servers versions < 4.4.

• changeStreamPreAndPostImages (document): Used to configure support for pre- and post-images in change streams.

  This is not supported for server versions < 6.0.

• clusteredIndex (document): A clustered index specification.

  This is not supported for server versions < 5.3.

• collation (document): Collation specification.
• encryptedFields (document): CSFLE 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.
• pipeline (array): An array that consists of the aggregation pipeline stage(s), which will be applied to the collection or view specified by viewOn.
• 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.
• viewOn (string): The name of the source collection or view from which to create the view.
• writeConcern (MongoDB\Driver\WriteConcern): Write concern.

See also

https://source.wiredtiger.com/2.4.1/struct_w_t___s_e_s_s_i_o_n.html#a358ca4141d59c345f401c58501276bbb

https://mongodb.com/docs/manual/core/schema-validation/

Parameters

string	$databaseName	Database name
string	$collectionName	Collection name
array	$options	Command options

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\CreateCollection::execute

(

Server

$server

)

Execute the operation.

See also

Executable\execute()

Return values

array|object

Command result document

Exceptions

DriverRuntimeException

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

Implements MongoDB\Operation\Executable.

---

The documentation for this class was generated from the following file:

• cache/stores/mongodb/MongoDB/Operation/CreateCollection.php