Skip to content

Latest commit

 

History

History
238 lines (107 loc) · 3.8 KB

CreateCollection.md

File metadata and controls

238 lines (107 loc) · 3.8 KB

CreateCollection

Operation for the create command.

See Also:

Constants

Constant Visibility Type Value
USE_POWER_OF_2_SIZES public 1
NO_PADDING public 2

Properties

databaseName

private string $databaseName

collectionName

private string $collectionName

options

private array $options

Methods

__construct

Constructs a create command.

public __construct(string $databaseName, string $collectionName, array $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:

Parameter Type Description
$databaseName string Database name
$collectionName string Collection name
$options array Command options

See Also:

execute

Execute the operation.

public execute(\MongoDB\Driver\Server $server): array|object

Parameters:

Parameter Type Description
$server \MongoDB\Driver\Server

Return Value:

Command result document

See Also:

  • \MongoDB\Operation\Executable::execute() -

createCommand

Create the create command.

private createCommand(): \MongoDB\Driver\Command

createOptions

Create options for executing the command.

private createOptions(): array

See Also: