diff --git a/language-snippets.ent b/language-snippets.ent index 2d535e7d4d22..ff149f67ff97 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -2901,69 +2901,6 @@ paths - -read_preferenceThe read preference mode: MongoClient::RP_PRIMARY, MongoClient::RP_PRIMARY_PREFERRED, MongoClient::RP_SECONDARY, MongoClient::RP_SECONDARY_PREFERRED, or MongoClient::RP_NEAREST.tagsAn array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.'> -Returns &true; on success, or &false; otherwise.'> -Emits E_WARNING if either parameter is invalid, or if one or more tag sets are provided with the MongoClient::RP_PRIMARY read preference mode.'> -This function returns an array describing the read preference. The array contains the values type for the string read preference mode (corresponding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag sets were specified, tagsets will not be present in the array.'> -wThe write concern. This may be an integer denoting the number of servers required to acknowledge the write, or a string mode (e.g. "majority").wtimeoutThe maximum number of milliseconds to wait for the server to satisfy the write concern.'> -Returns &true; on success, or &false; otherwise.'> -Emits E_WARNING if the w parameter is not an integer or string value.'> -This function returns an array describing the write concern. The array contains the values w for an integer acknowledgement level or string mode, and wtimeout denoting the maximum number of milliseconds to wait for the server to satisfy the write concern.'> -"maxTimeMS"Specifies a cumulative time limit in milliseconds for processing the operation on the server (does not include idle time). If the operation is not completed by the server within the timeout period, a MongoExecutionTimeoutException will be thrown.'> -"background"Builds the index in the background so that building an index does not block other database activities. Specify &true; to build in the background. The default value is &false;.Prior to MongoDB 2.6.0, index builds on secondaries were executed as foreground operations, irrespective of this option. See Building Indexes with Replica Sets for more information.'> -"dropDups"Specify &true; to force creation of a unique index where the collection may contain duplicate values for a key. MongoDB will index the first occurrence of a key and delete all subsequent documents from the collection that contain a duplicate value for that key. The default value is &false;."dropDups" may delete data from your database. Use with extreme caution.This option is not supported on MongoDB 2.8+. Index creation will fail if the collection contains duplicate values.'> -"expireAfterSeconds"The value of this option should specify the number of seconds after which a document should be considered expired and automatically removed from the collection. This option is only compatible with single-field indexes where the field will contain MongoDate values.This feature is available in MongoDB 2.2+. See Expire Data from Collections by Setting TTL for more information.'> -"name"A optional name that uniquely identifies the index.By default, the driver will generate an index name based on the index's field(s) and ordering or type. For example, a compound index array("x" => 1, "y" => -1) would be named "x_1_y_-1" and a geospatial index array("loc" => "2dsphere") would be named "loc_2dsphere". For indexes with many fields, it is possible that the generated name might exceed MongoDB's limit for index names. The "name" option may be used in that case to supply a shorter name.'> -"sparse"Specify &true; to create a sparse index, which only indexes documents containing a specified field. The default value is &false;.'> -"unique"Specify &true; to create a unique index. The default value is &false;. This option applies only to ascending/descending indexes.When MongoDB indexes a field, if a document does not have a value for the field, a &null; value is indexed. If multiple documents do not contain a field, a unique index will reject all but the first of those documents. The "sparse" option may be used to overcome this, since it will prevent documents without the field from being indexed.'> -This method will use the listCollections database command when communicating with MongoDB 2.8+. For previous database versions, the method will query the special system.namespaces collection.'> -"filter"Optional query criteria. If provided, this criteria will be used to filter the collections included in the result.Relevant fields that may be queried include "name" (collection name as a string, without the database name prefix) and "options" (object containing options used to create the collection)..MongoDB 2.6 and earlier versions require the "name" criteria, if specified, to be a string value (i.e. equality match). This is because the driver must prefix the value with the database name in order to query the system.namespaces collection. Later versions of MongoDB do not have this limitation, as the driver will use the listCollections command.'> -"includeSystemCollections"Boolean, defaults to &false;. Determines whether system collections should be included in the result.'> -"w"See Write Concerns. The default value for MongoClient is 1.'> -"wtimeout"Deprecated alias for "wTimeoutMS".'> -"wTimeoutMS"This option specifies the time limit, in milliseconds, for write concern acknowledgement. It is only applicable when "w" is greater than 1, as the timeout pertains to replication. If the write concern is not satisfied within the time limit, a MongoCursorException will be thrown. A value of 0 may be specified to block indefinitely. The default value for MongoClient is 10000 (ten seconds).'> -"fsync"Boolean, defaults to &false;. If journaling is enabled, it works exactly like "j". If journaling is not enabled, the write operation blocks until it is synced to database files on disk. If &true;, an acknowledged insert is implied and this option will override setting "w" to 0.If journaling is enabled, users are strongly encouraged to use the "j" option instead of "fsync". Do not use "fsync" and "j" simultaneously, as that will result in an error.'> -"socketTimeoutMS"This option specifies the time limit, in milliseconds, for socket communication. If the server does not respond within the timeout period, a MongoCursorTimeoutException will be thrown and there will be no way to determine if the server actually handled the write or not. A value of -1 may be specified to block indefinitely. The default value for MongoClient is 30000 (30 seconds).'> -"j"Boolean, defaults to &false;. Forces the write operation to block until it is synced to the journal on disk. If &true;, an acknowledged write is implied and this option will override setting "w" to 0.If this option is used and journaling is disabled, MongoDB 2.6+ will raise an error and the write will fail; older server versions will simply ignore the option.'> -"safe"Deprecated. Please use the write concern "w" option.'> -"timeout"Deprecated alias for "socketTimeoutMS".'> -Throws MongoCursorException if the "w" option is set and the write fails.Throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.'> -Issues E_DEPRECATED warning'> -These fields may also overwrite those that would be created automatically by the driver, as described in the MongoDB core documentation for the files collection. Some practical use cases for this behavior would be to specify a custom chunkSize or _id for the file.'> -Returns the _id of the saved file document. This will be a generated MongoId unless an _id was explicitly specified in the metadata parameter.'> -An array of Write Options.keyvalue meaningw (int|string)Write concern valuewtimeout (int)Maximum time to wait for replicationorderedDetermines if MongoDB must apply this batch in order. Ordered writes execute serially (i.e. one at a time) and execution will stop after the first error. Unordered writes may execute in parallel and execution will not stop after the first error. Defaults to &true;j (bool)Wait for journaling on the primary. This value is discouraged, use WriteConcern insteadfsync (bool)Wait for fsync on the primary. This value is discouraged, use WriteConcern instead'> -The MongoCollection to execute the batch on. Its write concern will be copied and used as the default write concern if none is given as $write_options or during MongoWriteBatch::execute.'> - server An array containing the basic information about the server that was picked. key value hash server hash, example: localhost:27017;-;X;56052 type Node type (primary/secondary/mongos/arbiter): 2 max_bson_size The maximum BSON Size over the wire this node accepts: 16777216 max_message_size The maximum Message Size over the wire this node accepts: 48000000 request_id The request identifier for this message: 42 '> - writeOptions key value ordered boolean, if the operation (in case of batch operation) must be executed sequentually (ordered=true) writeConcern An array of writeConcern options (see below) writeConcern array values key value fsync boolean, force flushing to disk before returning j boolean, force journal write before returning wtimeout integer, milliseconds, maximum time the primary is allowed to wait to verify replication w integer=server count, or string=replication-tag
'> - protocolOptions key value message_length The total size (in bytes) of the encoded message being sent over the wire request_id The request identifier for this message: 42 namespace The MongoDB namespace used for the protocol message dbname.collectionname '> -This extension that defines this class -is deprecated. Instead, the MongoDB extension should be used. -Alternatives to this class include:'> -This extension that defines this class -is deprecated. Instead, the MongoDB extension should be used. -There is no equivalent for this class in the new extension.'> -This extension that defines this method -is deprecated. Instead, the MongoDB extension should be used. -Alternatives to this method include:'> -This extension that defines this method -is deprecated. Instead, the MongoDB extension should be used. -There is no equivalent for this method in the new extension.'> -This extension that defines this method -is deprecated. Instead, the MongoDB extension should be used. -There is no equivalent for this method in the new extension, but there is an -alternative in the PHP library:'> - -This extension is deprecated. Instead, -the MongoDB extension should be -used.'> -