MongoCollectionTDefaultDocument Class |
Represents a MongoDB collection and the settings used to access it as well as a default document type. This class is thread-safe.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.11.0+cb27a82ea70620ad1acad8058809be8302ae4f2a
SyntaxType Parameters
- TDefaultDocument
- The default document type of the collection.
The MongoCollectionTDefaultDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MongoCollectionTDefaultDocument | Obsolete.
Creates a new instance of MongoCollection. Normally you would call one of the indexers or GetCollection methods
of MongoDatabase instead.
|
Properties| Name | Description | |
|---|---|---|
 | Database |
Gets the database that contains this collection.
(Inherited from MongoCollection.) |
| FullName |
Gets the fully qualified name of this collection.
(Inherited from MongoCollection.) |
| Name |
Gets the name of this collection.
(Inherited from MongoCollection.) |
| Settings |
Gets the settings being used to access this collection.
(Inherited from MongoCollection.) |
Methods| Name | Description | |
|---|---|---|
| Aggregate |
Represents an aggregate framework query. The command is not sent to the server until the result is enumerated.
(Inherited from MongoCollection.) |
| AggregateExplain |
Runs an aggregate command with explain set and returns the explain result.
(Inherited from MongoCollection.) |
| Count |
Counts the number of documents in this collection.
(Inherited from MongoCollection.) |
| Count(CountArgs) |
Counts the number of documents in this collection that match a query.
(Inherited from MongoCollection.) |
| Count(IMongoQuery) |
Counts the number of documents in this collection that match a query.
(Inherited from MongoCollection.) |
| CreateIndex(String) |
Creates an index for this collection.
(Inherited from MongoCollection.) |
| CreateIndex(IMongoIndexKeys) |
Creates an index for this collection.
(Inherited from MongoCollection.) |
| CreateIndex(IMongoIndexKeys, IMongoIndexOptions) |
Creates an index for this collection.
(Inherited from MongoCollection.) |
| Distinct(String) |
Returns the distinct values for a given field.
(Inherited from MongoCollection.) |
| Distinct(String, IMongoQuery) |
Returns the distinct values for a given field for documents that match a query.
(Inherited from MongoCollection.) |
| DistinctTValue(DistinctArgs) |
Returns the distinct values for a given field.
(Inherited from MongoCollection.) |
| Drop |
Drops this collection.
(Inherited from MongoCollection.) |
| DropAllIndexes |
Drops all indexes on this collection.
(Inherited from MongoCollection.) |
| DropIndex(String) |
Drops an index on this collection.
(Inherited from MongoCollection.) |
| DropIndex(IMongoIndexKeys) |
Drops an index on this collection.
(Inherited from MongoCollection.) |
| DropIndexByName |
Drops an index on this collection.
(Inherited from MongoCollection.) |
| EnsureIndex(String) | Obsolete.
Ensures that the desired index exists and creates it if it does not.
(Inherited from MongoCollection.) |
| EnsureIndex(IMongoIndexKeys) | Obsolete.
Ensures that the desired index exists and creates it if it does not.
(Inherited from MongoCollection.) |
| EnsureIndex(IMongoIndexKeys, IMongoIndexOptions) | Obsolete.
Ensures that the desired index exists and creates it if it does not.
(Inherited from MongoCollection.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Exists |
Tests whether this collection exists.
(Inherited from MongoCollection.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Find |
Returns a cursor that can be used to find all documents in this collection that match the query as TDefaultDocuments.
|
| FindAll |
Returns a cursor that can be used to find all documents in this collection as TDefaultDocuments.
|
| FindAllAs(Type) |
Returns a cursor that can be used to find all documents in this collection as TDocuments.
(Inherited from MongoCollection.) |
| FindAllAsTDocument |
Returns a cursor that can be used to find all documents in this collection as TDocuments.
(Inherited from MongoCollection.) |
| FindAndModify(FindAndModifyArgs) |
Finds one matching document using the supplied arguments and applies the specified update to it.
(Inherited from MongoCollection.) |
| FindAndModify(IMongoQuery, IMongoSortBy, IMongoUpdate) | Obsolete.
Finds one matching document using the query and sortBy parameters and applies the specified update to it.
(Inherited from MongoCollection.) |
| FindAndModify(IMongoQuery, IMongoSortBy, IMongoUpdate, Boolean) | Obsolete.
Finds one matching document using the query and sortBy parameters and applies the specified update to it.
(Inherited from MongoCollection.) |
| FindAndModify(IMongoQuery, IMongoSortBy, IMongoUpdate, Boolean, Boolean) | Obsolete.
Finds one matching document using the query and sortBy parameters and applies the specified update to it.
(Inherited from MongoCollection.) |
| FindAndModify(IMongoQuery, IMongoSortBy, IMongoUpdate, IMongoFields, Boolean, Boolean) | Obsolete.
Finds one matching document using the query and sortBy parameters and applies the specified update to it.
(Inherited from MongoCollection.) |
| FindAndRemove(FindAndRemoveArgs) |
Finds one matching document using the supplied args and removes it from this collection.
(Inherited from MongoCollection.) |
| FindAndRemove(IMongoQuery, IMongoSortBy) | Obsolete.
Finds one matching document using the query and sortBy parameters and removes it from this collection.
(Inherited from MongoCollection.) |
| FindAs(Type, IMongoQuery) |
Returns a cursor that can be used to find all documents in this collection that match the query as TDocuments.
(Inherited from MongoCollection.) |
| FindAsTDocument(IMongoQuery) |
Returns a cursor that can be used to find all documents in this collection that match the query as TDocuments.
(Inherited from MongoCollection.) |
| FindOne |
Returns one document in this collection as a TDefaultDocument.
|
| FindOne(IMongoQuery) |
Returns one document in this collection that matches a query as a TDefaultDocument.
|
| FindOneAs(Type) |
Returns one document in this collection as a TDocument.
(Inherited from MongoCollection.) |
| FindOneAs(Type, FindOneArgs) |
Returns one document in this collection as a TDocument.
(Inherited from MongoCollection.) |
| FindOneAs(Type, IMongoQuery) |
Returns one document in this collection that matches a query as a TDocument.
(Inherited from MongoCollection.) |
| FindOneAsTDocument |
Returns one document in this collection as a TDocument.
(Inherited from MongoCollection.) |
| FindOneAsTDocument(FindOneArgs) |
Returns one document in this collection as a TDocument.
(Inherited from MongoCollection.) |
| FindOneAsTDocument(IMongoQuery) |
Returns one document in this collection that matches a query as a TDocument.
(Inherited from MongoCollection.) |
| FindOneById |
Returns a cursor that can be used to find one document in this collection by its _id value as a TDefaultDocument.
|
| FindOneByIdAs(Type, BsonValue) |
Returns a cursor that can be used to find one document in this collection by its _id value as a TDocument.
(Inherited from MongoCollection.) |
| FindOneByIdAsTDocument(BsonValue) |
Returns a cursor that can be used to find one document in this collection by its _id value as a TDocument.
(Inherited from MongoCollection.) |
| GeoHaystackSearch(GeoHaystackSearchArgs) | Obsolete.
Runs a geoHaystack search command on this collection.
|
| GeoHaystackSearch(Double, Double, IMongoGeoHaystackSearchOptions) | Obsolete.
Runs a geoHaystack search command on this collection.
|
| GeoHaystackSearchAs(Type, GeoHaystackSearchArgs) | Obsolete.
Runs a geoHaystack search command on this collection.
(Inherited from MongoCollection.) |
| GeoHaystackSearchAs(Type, Double, Double, IMongoGeoHaystackSearchOptions) | Obsolete.
Runs a geoHaystack search command on this collection.
(Inherited from MongoCollection.) |
| GeoHaystackSearchAsTDocument(GeoHaystackSearchArgs) | Obsolete.
Runs a geoHaystack search command on this collection.
(Inherited from MongoCollection.) |
| GeoHaystackSearchAsTDocument(Double, Double, IMongoGeoHaystackSearchOptions) | Obsolete.
Runs a geoHaystack search command on this collection.
(Inherited from MongoCollection.) |
| GeoNear(GeoNearArgs) |
Runs a GeoNear command on this collection.
|
| GeoNear(IMongoQuery, Double, Double, Int32) | Obsolete.
Runs a GeoNear command on this collection.
|
| GeoNear(IMongoQuery, Double, Double, Int32, IMongoGeoNearOptions) | Obsolete.
Runs a GeoNear command on this collection.
|
| GeoNearAs(Type, GeoNearArgs) |
Runs a GeoNear command on this collection.
(Inherited from MongoCollection.) |
| GeoNearAs(Type, IMongoQuery, Double, Double, Int32) | Obsolete.
Runs a GeoNear command on this collection.
(Inherited from MongoCollection.) |
| GeoNearAs(Type, IMongoQuery, Double, Double, Int32, IMongoGeoNearOptions) | Obsolete.
Runs a GeoNear command on this collection.
(Inherited from MongoCollection.) |
| GeoNearAsTDocument(GeoNearArgs) |
Runs a GeoNear command on this collection.
(Inherited from MongoCollection.) |
| GeoNearAsTDocument(IMongoQuery, Double, Double, Int32) | Obsolete.
Runs a GeoNear command on this collection.
(Inherited from MongoCollection.) |
| GeoNearAsTDocument(IMongoQuery, Double, Double, Int32, IMongoGeoNearOptions) | Obsolete.
Runs a GeoNear command on this collection.
(Inherited from MongoCollection.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetIndexes |
Gets the indexes for this collection.
(Inherited from MongoCollection.) |
| GetStats |
Gets the stats for this collection.
(Inherited from MongoCollection.) |
| GetStats(GetStatsArgs) |
Gets the stats for this collection.
(Inherited from MongoCollection.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Group(GroupArgs) | Obsolete.
Runs the group command on this collection.
(Inherited from MongoCollection.) |
| Group(IMongoQuery, BsonJavaScript, BsonDocument, BsonJavaScript, BsonJavaScript) | Obsolete.
Runs the group command on this collection.
(Inherited from MongoCollection.) |
| Group(IMongoQuery, IMongoGroupBy, BsonDocument, BsonJavaScript, BsonJavaScript) | Obsolete.
Runs the group command on this collection.
(Inherited from MongoCollection.) |
| Group(IMongoQuery, String, BsonDocument, BsonJavaScript, BsonJavaScript) | Obsolete.
Runs the group command on this collection.
(Inherited from MongoCollection.) |
| IndexExists(String) |
Tests whether an index exists.
(Inherited from MongoCollection.) |
| IndexExists(IMongoIndexKeys) |
Tests whether an index exists.
(Inherited from MongoCollection.) |
| IndexExistsByName |
Tests whether an index exists.
(Inherited from MongoCollection.) |
| InitializeOrderedBulkOperation |
Creates a fluent builder for an ordered bulk operation.
|
| InitializeOrderedBulkOperationAsTDocument |
Creates a fluent builder for an ordered bulk operation.
(Inherited from MongoCollection.) |
| InitializeUnorderedBulkOperation |
Creates a fluent builder for an unordered bulk operation.
|
| InitializeUnorderedBulkOperationAsTDocument |
Creates a fluent builder for an unordered bulk operation.
(Inherited from MongoCollection.) |
| Insert(TDefaultDocument) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
|
| Insert(Type, Object) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
(Inherited from MongoCollection.) |
| Insert(TDefaultDocument, MongoInsertOptions) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
|
| Insert(TDefaultDocument, WriteConcern) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
|
| Insert(Type, Object, MongoInsertOptions) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
(Inherited from MongoCollection.) |
| Insert(Type, Object, WriteConcern) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
(Inherited from MongoCollection.) |
| InsertTNominalType(TNominalType) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
(Inherited from MongoCollection.) |
| InsertTNominalType(TNominalType, MongoInsertOptions) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
(Inherited from MongoCollection.) |
| InsertTNominalType(TNominalType, WriteConcern) |
Inserts a document into this collection (see also InsertBatch to insert multiple documents at once).
(Inherited from MongoCollection.) |
| InsertBatch(IEnumerableTDefaultDocument) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
|
| InsertBatch(Type, IEnumerable) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
(Inherited from MongoCollection.) |
| InsertBatch(IEnumerableTDefaultDocument, MongoInsertOptions) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
|
| InsertBatch(IEnumerableTDefaultDocument, WriteConcern) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
|
| InsertBatch(Type, IEnumerable, MongoInsertOptions) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
(Inherited from MongoCollection.) |
| InsertBatch(Type, IEnumerable, WriteConcern) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
(Inherited from MongoCollection.) |
| InsertBatchTNominalType(IEnumerableTNominalType) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
(Inherited from MongoCollection.) |
| InsertBatchTNominalType(IEnumerableTNominalType, MongoInsertOptions) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
(Inherited from MongoCollection.) |
| InsertBatchTNominalType(IEnumerableTNominalType, WriteConcern) |
Inserts multiple documents at once into this collection (see also Insert to insert a single document).
(Inherited from MongoCollection.) |
| IsCapped |
Tests whether this collection is capped.
(Inherited from MongoCollection.) |
| MapReduce |
Runs a map-reduce command on this collection.
(Inherited from MongoCollection.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ParallelScan | Obsolete.
Scans an entire collection in parallel using multiple cursors.
|
| ParallelScanAs(Type, ParallelScanArgs) | Obsolete.
Scans an entire collection in parallel using multiple cursors.
(Inherited from MongoCollection.) |
| ParallelScanAsTDocument(ParallelScanArgsTDocument) | Obsolete.
Scans an entire collection in parallel using multiple cursors.
(Inherited from MongoCollection.) |
| ReIndex | Obsolete.
Runs the ReIndex command on this collection.
(Inherited from MongoCollection.) |
| Remove(IMongoQuery) |
Removes documents from this collection that match a query.
(Inherited from MongoCollection.) |
| Remove(RemoveArgs) |
Removes documents from this collection that match a query.
(Inherited from MongoCollection.) |
| Remove(IMongoQuery, RemoveFlags) |
Removes documents from this collection that match a query.
(Inherited from MongoCollection.) |
| Remove(IMongoQuery, WriteConcern) |
Removes documents from this collection that match a query.
(Inherited from MongoCollection.) |
| Remove(IMongoQuery, RemoveFlags, WriteConcern) |
Removes documents from this collection that match a query.
(Inherited from MongoCollection.) |
| RemoveAll |
Removes all documents from this collection (see also Drop).
(Inherited from MongoCollection.) |
| RemoveAll(WriteConcern) |
Removes all documents from this collection (see also Drop).
(Inherited from MongoCollection.) |
| Save(TDefaultDocument) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
|
| Save(Type, Object) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
(Inherited from MongoCollection.) |
| Save(TDefaultDocument, MongoInsertOptions) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
|
| Save(TDefaultDocument, WriteConcern) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
|
| Save(Type, Object, MongoInsertOptions) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
(Inherited from MongoCollection.) |
| Save(Type, Object, WriteConcern) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
(Inherited from MongoCollection.) |
| SaveTNominalType(TNominalType) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
(Inherited from MongoCollection.) |
| SaveTNominalType(TNominalType, MongoInsertOptions) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
(Inherited from MongoCollection.) |
| SaveTNominalType(TNominalType, WriteConcern) |
Saves a document to this collection. The document must have an identifiable Id field. Based on the value
of the Id field Save will perform either an Insert or an Update.
(Inherited from MongoCollection.) |
| ToString |
Gets a canonical string representation for this database.
(Inherited from MongoCollection.) |
| Update(IMongoQuery, IMongoUpdate) |
Updates one matching document in this collection.
(Inherited from MongoCollection.) |
| Update(IMongoQuery, IMongoUpdate, MongoUpdateOptions) |
Updates one or more matching documents in this collection (for multiple updates use UpdateFlags.Multi).
(Inherited from MongoCollection.) |
| Update(IMongoQuery, IMongoUpdate, UpdateFlags) |
Updates one or more matching documents in this collection (for multiple updates use UpdateFlags.Multi).
(Inherited from MongoCollection.) |
| Update(IMongoQuery, IMongoUpdate, WriteConcern) |
Updates one matching document in this collection.
(Inherited from MongoCollection.) |
| Update(IMongoQuery, IMongoUpdate, UpdateFlags, WriteConcern) |
Updates one or more matching documents in this collection (for multiple updates use UpdateFlags.Multi).
(Inherited from MongoCollection.) |
| Validate |
Validates the integrity of this collection.
(Inherited from MongoCollection.) |
| Validate(ValidateCollectionArgs) |
Validates the integrity of this collection.
(Inherited from MongoCollection.) |
| WithReadConcern |
Returns a new MongoCollection instance with a different read concern setting.
|
| WithReadPreference |
Returns a new MongoCollection instance with a different read preference setting.
|
| WithWriteConcern |
Returns a new MongoCollection instance with a different write concern setting.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsQueryableT | Overloaded.
Returns an instance of IQueryable{{T}} for a MongoCollection.
(Defined by LinqExtensionMethods.) |
| AsQueryableT | Overloaded.
Returns an instance of IQueryable{{T}} for a MongoCollection.
(Defined by LinqExtensionMethods.) |
| ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also