SODAオブジェクト

SODA APIで使用されるオブジェクト。

SODA APIの中核となるオブジェクトは、次のとおりです:
  • SodaDatabase: SODA操作の最上位オブジェクト。これは、Oracle Database接続から取得するか、sodaオブジェクトとしてグローバル・スコープから直接使用できます。SODAデータベースは抽象化されたものであるため、そのSODAデータベース内のSODAコレクションにアクセスでき、そのコレクション内のドキュメントにアクセスできます。SODAデータベースは、Oracle Databaseのユーザーまたはスキーマに似ています。コレクションは表に似ています。ドキュメントは、1つの列に一意のドキュメント・キー、1つの列にドキュメント・コンテンツ、およびその他の列に様々なドキュメント属性を含む表の行に似ています。MLE JavaScript SQLドライバでは、sodaオブジェクトをグローバル変数として使用できます。これはSodaDatabaseオブジェクトを表し、ボイラプレート・コードを記述する必要性が少なくなります。

  • SodaCollection: SODAドキュメントのコレクションを表します。デフォルトでは、コレクションを使用するとJSONドキュメントを格納でき、各ドキュメントにデフォルトのメタデータ・セットが追加されます。ほとんどのユーザーにはこれをお薦めします。ただし、オプションのメタデータを使用すると、そのデータベース・ストレージ、バージョンおよびタイムスタンプ・ドキュメント・コンポーネントの追跡の有無、それらのコンポーネントの生成方法、サポートされるドキュメント・タイプなど、コレクションに関する様々な詳細を設定できます。ほとんどのユーザーは、カスタム・メタデータを指定する必要はありません。

  • SodaDocument: ドキュメントを表します。通常、ドキュメント・コンテンツはJSONです。ドキュメントには、コンテンツ、キー、タイムスタンプ、メディア・タイプなどのプロパティがあります。デフォルトでは、ドキュメント・キーが自動的に生成されます。

ここに格納されたコレクションおよびドキュメントを操作する場合は、次のオブジェクトを使用します:
  • SodaDocumentCursor: find()操作からのgetCursor()メソッドの結果を表すカーソル・オブジェクト。反復すると、各SodaDocumentにアクセスできます。

  • SodaOperation: ドキュメントに対する読取りおよび書込み操作を実行するためにfind()で使用される内部オブジェクト。つなげられたメソッドにより、SodaOperationオブジェクトにプロパティが設定されます。これをターミナル・メソッドで使用して、ドキュメントを検索、カウント、置換または削除します。これは、直接アクセスできない内部オブジェクトです。

関連項目:

mle-js-oracledbでのSODAオブジェクトの使用の詳細は、サーバー側JavaScript APIのドキュメントを参照してください