コレクションの操作

この項では、コレクションの作成と管理に使用する操作について説明します。

次のlistCollections操作の構文に示すように、すべてのコレクションの操作には、オプションのouterTransactionId要素とlanguage要素があります。

<listCollections>
   <!--Optional:-->
   <outerTransactionId>?</outerTransactionId>
   <!--Optional:-->
   <language>en</language>
</listCollections>

これらの機能はすべてのコレクションの操作で同じであるため、これらの2つの要素については各操作の説明内ではなくここで説明します。

outerTransactionId要素

オプションのouterTransactionId要素は、外部トランザクションのIDを指定します(トランザクションがトランザクションWebサービスによって開始されている場合)。外部トランザクションが進行中でないときに外部トランザクションIDを指定することは正しくありません。外部トランザクションIDが間違って指定されたすべての構成リクエストはSOAPフォルトで失敗します。

一部の操作(updateCollectionsなど)では、同じリクエストにより複数のコレクションを処理できます。ただし、これらの操作はアトミックであるため、操作が成功する(つまり、すべてのコレクションが正常に処理される)か、操作全体が失敗する(少なくとも1つのコレクションを変更できない)かのいずれかになります。コレクション・レコードを非決定的な状態にしないために、最初に外部トランザクションを開いて、outerTransactionId要素付きで操作を実行した後、操作失敗時にトランザクションをロールバックできます。

language要素

オプションのlanguage要素は、EQL解析で生じるエラー・メッセージの言語を設定します。エラー・メッセージのデフォルト言語はen(英語)です。この要素とそのサポートされる言語コードの詳細は、「EQLエラー・メッセージの言語コード」のEQLのLanguage要素に関する説明を参照してください。