FireDAC.Phys.MongoDBWrapper.TMongoDatabase.DropCollection

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DropCollection(const AName: String; AIgnoreObjNotExists: Boolean = False);

C++

void __fastcall DropCollection(const System::UnicodeString AName, bool AIgnoreObjNotExists = false);

Properties

Type Visibility Source Unit Parent
procedure
function
public
FireDAC.Phys.MongoDBWrapper.pas
FireDAC.Phys.MongoDBWrapper.hpp
FireDAC.Phys.MongoDBWrapper TMongoDatabase

Description

Removes the collection with the specified name from the database.

If the database does not contain a collection with the specified name, the value of AIgnoreObjNotExists determines the behavior of DropCollection:

  • If AIgnoreObjNotExists is False, DropCollection raises an exception.
  • If AIgnoreObjNotExists is True, DropCollection does not raise any exception.

See Also