FireDAC.Phys.MongoDBWrapper.TMongoDocument.Add

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function Add(const AKey: String; const AValue: String): TMongoDocument; overload;
function Add(const AKey: String; const AValue: Int32): TMongoDocument; overload;
function Add(const AKey: String; const AValue: Int64): TMongoDocument; overload;
function Add(const AKey: String; const AValue: Extended): TMongoDocument; overload;
function Add(const AKey: String; const AValue: Boolean): TMongoDocument; overload;
function Add(const AKey: String; const AValue: TDateTime): TMongoDocument; overload;
function Add(const AKey: String; const AValue: TBytes;
ABinaryType: TJsonBinaryType = TJsonBinaryType.Generic): TMongoDocument; overload;
function Add(const AKey: String; const AValue: TMongoOID): TMongoDocument; overload;
function Add(const AKey: String; const AValue: TJsonOid): TMongoDocument; overload;
function Add(const AKey: string; const AValue: TJsonRegEx): TMongoDocument; overload;
function Add(const AKey: string; const AValue: TJsonDBRef): TMongoDocument; overload;
function Add(const AKey: string; const AValue: TJsonCodeWScope): TMongoDocument; overload;
function Add(const AKey: string; const AValue: TJsonDecimal128): TMongoDocument; overload;
function Add(const AKey: String; const AValue: TVarRec): TMongoDocument; overload;
function Add(const AKey: String; const AValues: array of const): TMongoDocument; overload;
function Add(const AKey: String; const AValue: Variant): TMongoDocument; overload;

C++ 

TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::UnicodeString AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Int32 AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const __int64 AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Extended AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const bool AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::TDateTime AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Sysutils::TBytes AValue, System::Json::Types::TJsonBinaryType ABinaryType = (System::Json::Types::TJsonBinaryType)(0x0))/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, TMongoOID* const AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Json::Types::TJsonOid &AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Json::Types::TJsonRegEx &AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Json::Types::TJsonDBRef &AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Json::Types::TJsonCodeWScope &AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Json::Types::TJsonDecimal128 &AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::TVarRec &AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::TVarRec *AValues, const System::NativeInt AValues_High)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Variant &AValue)/* overload */;

Properties

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

Description

Adds a key-value pair or an array element of a specific type and returns a reference to this object.

Use this method to add a new key-value pair or an array element to a MongoDB document.

This method is overloaded. Use an appropriated overloaded method to add a key-value pair or an array element of a specific type.

Method Header Description 
 Add(const AKey: String; const AValue: String)

Adds a key-value pair or an array element of String type. 

Add(const AKey: String; const AValue: Int32)

Adds a key-value pair or an array element of Int32 type. 

Add(const AKey: String; const AValue: Int64)

Adds a key-value pair or an array element of Int64 type. 

Add(const AKey: String; const AValue: Extended)

Adds a key-value pair or an array element of Extended type. 

Add(const AKey: String; const AValue: Boolean)

Adds a key-value pair or an array element of Boolean type. 

Add(const AKey: String; const AValue: TDateTime)

Adds a key-value pair or an array element of TDateTime type. 

Add(const AKey: String; const AValue: TBytes;
      ABinaryType: TJsonBinaryType = TJsonBinaryType.Generic)

Adds a key-value pair or an array element of TBytes type. Optionally, you can specify the ABinaryType parameter, which corresponds to BSON binary subtypes. 

Add(const AKey: String; const AValue: TMongoOID)

Adds a key-value pair or an array element of TMongoOID type. 

Add(const AKey: String; const AValue: TJsonOid)

Adds a key-value pair or an array element of TJsonOid type. 

Add(const AKey: String; const AValue: TJsonRegEx)

Adds a key-value pair or an array element of TJsonRegEx type. 

Add(const AKey: String; const AValue: TJsonDBRef)

Adds a key-value pair or an array element of TJsonDBRef type. 

Add(const AKey: String; const AValue: TJsonCodeWScope)

Adds a key-value pair or an array element of TJsonCodeWScope type. 

Add(const AKey: String; const AValue: TVarRec)

Adds a key-value pair or an array element of TVarRec type. 

Add(const AKey: String; const AValues: array of const)

Adds a nested array using the AValues open array as the array elements.

The open array represents a "parsed" JSON. To add various items, do the following:

  • To add a key-value pair, specify the key name, followed by a value
  • To add an array element, specify just a value
  • To add a nested object, its key-value pairs must be surrounded by '{' and '}
  • To add a nested array, its elements must be surrounded by '[' and ']'.

For example:

    • Add('coords', [123.45, 80.90]) -> "coords": [123.45, 80.90]
    • Add('grades', ['{', 'grade', 'A', 'score', 11, '}', '{', 'grade', 'B', 'score', 17, '}']) -> "grades": [{"grade": "A", "score": 11}, {"grade": "B", "score": 17}]
Add(const AKey: String; const AValue: Variant)

Adds a key-value pair or an array element of a type represented by the Variant data type.

NOTE: When you add an array, the AKey value is ignored. For readability you can specify array index.

Examples

To clarify, consider the following examples:

Delphi:

var
  oDoc: TMongoDocument;
....
  oDoc := FEnv.NewDoc;
  oDoc
    .BeginObject('address')
      .Add('street', '2 Avenue')
      .Add('zipcode', '10075')
      .Add('building', '1480')
      .BeginArray('coord')
        .Add('0', -73.9557413)
        .Add('1', 40.7720266)
      .EndArray
    .EndObject
    .Add('borough', 'Manhattan')
    .Add('cuisine', 'Italian');

C++Builder: 

....
  TMongoDocument *oDoc = FEnv->NewDoc();
  oDoc
    ->BeginObject("address")
      ->Add("street", System::UnicodeString("2 Avenue"))
      ->Add("zipcode", System::UnicodeString("10075"))
      ->Add("building", System::UnicodeString("1480"))
      ->BeginArray("coord")
        ->Add("0", -73.9557413)
        ->Add("1", 40.7720266)
      ->EndArray()
    ->EndObject()
    ->Add("borough", System::UnicodeString("Manhattan"))
    ->Add("cuisine", System::UnicodeString("Italian"));

See Also

Retrieved from "https://docwiki.embarcadero.com/Libraries/Athens/e/index.php?title=FireDAC.Phys.MongoDBWrapper.TMongoDocument.Add&oldid=735579"