FireDAC.Phys.MongoDBWrapper.TMongoPipeline Methods

From RAD Studio API Documentation
Jump to: navigation, search


InheritedProtected
__MarkDestroyingprotected
_AddRefprotectedImplements the IInterface_AddRef method.
_ReleaseprotectedImplements the IInterface_Release method.
AfterConstructionpublicResponds after the last constructor executes.
BeforeDestructionpublicChecks that the reference count is zero before allowing the interfaced object to be destroyed.
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.
CreatepublicCreates an instance of TMongoPipeline that uses the specified MongoDB environment.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DestroypublicDestroys this instance of TMongoPipeline.
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.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
FieldAddresspublicReturns the address of a published object field.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
GeoNearpublicReturns a reference to the $geoNear stage builder, which outputs documents in order of nearest to farthest from a specified center point.
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.
GrouppublicRetuns a reference to an expression builder to define a group pipeline stage that groups documents based on the defined expression.
IndexStatspublicDefines the $indexStats stage that returns statistics regarding the use of each index for the collection.
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.
InstanceSizepublicReturns the size in bytes of each instance of the object type.
LimitpublicLimits to AValue the number of documents passed to the next stage.
LookuppublicDefines the $lookup stage that performs a left outer join to an unsharded collection in the same database to filter in documents from the “joined” collection for processing.
MatchpublicRetuns a reference to an expression builder for the match pipeline stage that filters documents documents based on the defined expression.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
NewInstancepublicAllocates memory for each instance of an interfaced object.
OpenpublicExplicitly executes this pipeline and returns a cursor.
operator ()publicCasts the cursor as _di_IMongoCursor.
OutpublicWrites documents to the specified collection.
ProjectpublicRetuns a reference to an expression builder for the project pipeline stage that passes only specified fields to the next stage.
QualifiedClassNamepublicReturns the qualified name of the class.
QueryInterfaceprotectedImplements the IInterfaceQueryInterface method.
RedactpublicRetuns a reference to an expression builder for the redact pipeline stage that restricts the content of documents based on the specified expression.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SamplepublicDefines the $sample stage that randomly selects the specified number of documents from its input.
SkippublicSkips AValue documents, which are not passed to the next stage.
SortpublicRetuns a reference to an expression builder for the sort pipeline stage that sorts documents based on the specified expression.
StagepublicReturns the reference to a generic stage builder identified by AName.
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UnwindpublicDeconstructs an array field at the specified path from the input documents to output a document for each element.