FireDAC.Phys.MongoDBWrapper.TMongoConnection

提供: RAD Studio API Documentation
移動先: 案内検索

FireDAC.Phys.MongoDBWrapper.TMongoObjectSystem.TObjectTMongoConnection

Delphi

TMongoConnection = class(TMongoObject)

C++

class PASCALIMPLEMENTATION TMongoConnection : public TMongoObject

プロパティ

種類 可視性 ソース ユニット
class public
FireDAC.Phys.MongoDBWrapper.pas
FireDAC.Phys.MongoDBWrapper.hpp
FireDAC.Phys.MongoDBWrapper FireDAC.Phys.MongoDBWrapper


説明

MongoDB サーバーへの接続を表し、自分のデータベースコレクションに他からアクセスできるようにします。

TMongoConnection のインスタンスを取得する場合は、インスタンスを直接作成しないでください。代わりに、お使いの MongoDB サーバーに接続するように TFDConnection コンポーネントを構成し、接続された状態にしたうえで、そのコンポーネントの CliObj プロパティを TMongoConnection にキャストします(下記参照)。

Delphi の場合:

FDConnection1.Connected := True;
MyConnection := TMongoConnection(FDConnection1.CliObj);

C++ の場合:

FDConnection1->Connected = true;
TMongoConnection* MyConnection = (TMongoConnection*) FDConnection1->CliObj;

TMongoConnection で表される接続はデフォルトで開いています。Open を使用すると、接続先の MongoDB サーバーを変更でき、Close を使用すると、接続を閉じることができます。

次のメンバを使用すると、MongoDB サーバーのデータにアクセスすることができます。

TMongoConnection には、次のように、MongoDB サーバーに関する情報を取得するためのメンバがいくつか用意されています。

  • ServerVersion(MongoDB サーバーのバージョンです)
  • URI(MongoDB サーバーの URI です)
  • GetServerStatus(データベース処理の状態の概要を説明するドキュメントを返します)
  • Ping(MongoDB サーバーがコマンドに応答しない場合に例外を発生させます)
  • max_bson_size(MongoDB サーバーに格納可能なドキュメントの最大サイズです)
  • max_message_size(MongoDB サーバーに送信可能な要求の最大サイズです)

データベース コマンドを実行するには、次のいずれかのメソッドを使用します。

  • Command(指定されたコマンドを実行し、すべての結果ドキュメントにアクセスするためのカーソルを返します)
  • CommandSimple(指定されたコマンドを実行し、サーバーからの応答が格納されたドキュメントを返します)

MongoDB サーバーのレプリカ セット読み書きセマンティクスを構成するには、次のプロパティを使用します。

SSLInit を使用すると、お使いの MongoDB サーバーと安全に通信できるようにクライアントの SSL オプションを構成できます。

TMongoConnection は MongoDB 構造体 mongoc_client_t をカプセル化したものです。