FireDAC.Phys.MongoDBWrapper.TMongoCollection Methods

From RAD Studio API Documentation
Jump to: navigation, search

InheritedProtected
AfterConstructionpublicResponds after the last constructor has executed.
AggregatepublicApplies the specified pipeline to the documents of the collection and returns a cursor to access the results.
BeforeDestructionpublicResponds before the first destructor executes.
BeginBulkpublicStarts a bulk operation on the collection.
CancelBulkpublicAborts a bulk operation previously started by a call to BeginBulk.
CheckDisposedprotected
ClassInfopublicReturns a pointer to the run-time type information (RTTI) table for the object type.
ClassNamepublicReturns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIspublicDetermines whether an object is of a specific type.
ClassParentpublicReturns the type of the immediate ancestor of a class.
ClassTypepublicReturns the class reference for the object's class.
CleanupInstancepublicPerforms finalization on long strings, variants, and interface variables within a class.
CommandpublicExecutes the specified database command on the collection and returns a cursor to access the results.
CommandSimplepublicExecutes the specified database command on the collection and returns a document that contains the response from the server.
CountpublicReturns the number of documents of the collection that match the specified query.
CreateprotectedCreates an instance of TMongoCollection.
CreateIndexpublicCreates the specified index in the collection.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DereferencepublicReturns the document of the collection that has the specified object ID.
DestroypublicDestroys an instance of TMongoCollection.
DispatchpublicCalls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOfpublicDisposeOf forces the execution of the destructor code in an object.
DroppublicRemoves the collection itself from the database that contains it.
DropIndexpublicRemoves the index with the specified name from the collection.
EndBulkpublicSubmits to the database all changes (Insert, Update, and Remove) that you applied to the collection since the last call to BeginBulk.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
FieldAddresspublicReturns the address of a published object field.
FindpublicFinds documents of the collection that match the specified query and returns a cursor to access the results.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeHandleprotectedClears the existing handle, and optionally releases the API handle, when it is owned by this object.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
GetDisposedprotectedGetter for the Disposed property.
GetHashCodepublicReturns an integer containing the hash code.
GetInterfacepublicRetrieves a specified interface.
GetInterfaceEntrypublicReturns the entry for a specific interface implemented in a class.
GetInterfaceTablepublicReturns a pointer to a structure containing all of the interfaces implemented by a given class.
HandleAllocatedprotectedProvides an additional API handle setup.
InheritsFrompublicDetermines the relationship of two object types.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InsertpublicInserts the specified document into the collection or executes the specified insert builder on the collection.
InstanceSizepublicReturns the size in bytes of each instance of the object type.
InternalFreeHandleprotectedReleases the MongoDB API handle.
ListIndexespublicReturns a cursor that you can use to access the list of indexes of the collection.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
QualifiedClassNamepublicReturns the qualified name of the class.
RemovepublicRemoves the documents that match the specified selector from the collection.
RemoveAllpublicRemoves all documents from the collection.
RenamepublicChanges the name of the collection and the database that contains the collection to the specified values.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
StatisticspublicReturns a document that contains statistics about the collection.
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UpdatepublicExecutes the specified update builder on the collection.
ValidatepublicExecutes the validate command on the collection and returns the document that it returns.