FireDAC.Phys.MongoDBWrapper.TMongoDocument.Add

De RAD Studio API Documentation
Aller à : navigation, rechercher

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: 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 int 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::DynamicArray<System::Byte> 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::TVarRec &AValue)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::TVarRec *AValues, const int AValues_High)/* overload */;
TMongoDocument* __fastcall Add(const System::UnicodeString AKey, const System::Variant &AValue)/* overload */;

Propriétés

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


Description

Ajoute une paire clé-valeur ou un élément de tableau d'un type spécifique et renvoie une référence à cet objet.

Utilisez cette méthode pour ajouter une nouvelle paire clé-valeur ou un élément de tableau à un document MongoDB.

Cette méthode est surchargée. Utilisez une méthode surchargée appropriée pour ajouter une paire clé-valeur ou un élément de tableau d'un type spécifique.

En-tête de méthode Description
 Add(const AKey: String; const AValue: String)

Ajoute une paire clé--valeur ou un élément de tableau de type String.

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

Ajoute une paire clé--valeur ou un élément de tableau de type Int32.

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

Ajoute une paire clé--valeur ou un élément de tableau de type Int64.

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

Ajoute une paire clé--valeur ou un élément de tableau de type Extended.

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

Ajoute une paire clé--valeur ou un élément de tableau de type Boolean.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TDateTime.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TBytes. Facultativement, vous pouvez spécifier le paramètre ABinaryType, ce qui correspond aux sous-types binaires BSON.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TMongoOID.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TJsonOid.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TJsonRegEx.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TJsonDBRef.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TJsonCodeWScope.

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

Ajoute une paire clé--valeur ou un élément de tableau de type TVarRec.

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

Ajoute un tableau imbriqué en utilisant le tableau ouvert AValues comme éléments de tableau.

Le tableau ouvert représente un JSON "analysé". Pour ajouter plusieurs éléments, procédez comme suit :

  • Pour ajouter une paire clé-valeur, spécifiez le nom de la clé en le faisant suivre par la valeur.
  • Pour ajouter un élément de tableau, spécifiez simplement une valeur.
  • Pour ajouter un objet imbriqué, ses paires clé-valeur doivent être encadrées par '{' et '}.
  • Pour ajouter un tableau imbriqué, ses éléments doivent être encadrés par '[' et ']'.

Par exemple :

    • 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)

Ajoute une paire clé--valeur ou un élément de tableau d'un type représenté par le type de données Variant.

REMARQUE : Lorsque vous ajoutez un tableau, la valeur AKey est ignorée. Pour une plus grande lisibilité, vous pouvez spécifier un index de tableau.

Exemples

A titre explicatif, prenons les exemples suivants :

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"));

Voir aussi