NFX.DataAccess.MongoDB.Connector NamespaceNFX Class Library

[This is preliminary documentation and is subject to change.]

 
Classes

  ClassDescription
Public classCollection
Represents MongoDB collections which allows to execute queries and perform CRUD operations
Public classConnection
Represent a connection to MongoDB server. Normally developers should not work with this class directly as connections are managed by the Client. This class is not thread safe and must be Acquired first before sending data
Public classCursor
Represents a UNIDIRECTIONAL SINGLE-pass (no buffering) cursor returned by the Find(query) command. The cursor needs to be closed by calling Dispose() if the eof has not been reached OR it will auto-close on EOF. The cursor may be enumerated only once. It is NOT thread-safe
Public classDatabase
Represents an instance of MongoDB database
Public classMongoClient
The central facade for working with MongoDB. The technology was tested against Mongo DB 3.0.6. The NFX MongoDB connector is purposely created for specific needs. It does not support: Mongo security, sharding and replication
Public classMongoDBConnectorException
Thrown by MongoDB data access classes
Public classMongoDBConnectorProtocolException
Thrown by MongoDB data access classes related to protocol
Public classMongoDBConnectorServerException
Thrown by MongoDB data access classes related to server errors
Public classMongoDBQueryException
Thrown in case of query compile error
Protected classProtocol
This class uses static methods on purpose to avoid allocations
Public classQuery
Represents a query document sent to MongoDB
Public classServerNode
Manages connections to the same server
Public classUpdate
Represents an update document sent to MongoDB
Structures

  StructureDescription
Public structureCRUDResult
Returned by CRUD operations from the server, contains information about total docs affected and write errors. The caller needs to inspect the TotalDocumentsAffected and WriteErrors to handle error conditions
Public structureCRUDUpsertInfo
Provides information about an upserted document
Public structureCRUDWriteError
Provides information about document write error
Public structureDeleteEntry
Pairs necessary information for deletes: query + limit flag
Public structureProtocol ReplyData
Public structureUpdateEntry
Pairs necessary information for updates: query, update documents along with upsert and multi flags
Enumerations

  EnumerationDescription
Public enumerationDeleteLimit
Denotes limits for deletion: None=Everything or One
Public enumerationProtocol QueryFlags
Public enumerationProtocol ResponseFlags
Public enumerationWriteConcern
Defines data safety modes http://docs.mongodb.org/manual/core/write-concern/