ドキュメント削除処理

オペレーション名

ドキュメント削除

機能概要

Microsoft Azure DocumentDBのコレクションに格納されているドキュメントを削除します。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
コレクション 必須 使用可 読み取るコレクションの名前を選択または入力します。  
削除対象条件 必須 使用可 削除するドキュメントを特定する条件を入力します。
  • SQLのwhere句を入力します。たとえば、personコレクションからageが21のドキュメントを対象とする場合は「person.age = 21」と入力します。
プロパティアクション
項目名 説明 備考
コレクション一覧の更新 指定した接続先からコレクションを取得して、[コレクション]に設定します。  
テスト実行 指定した削除対象条件でSQL文をテスト実行します。
  • [接続先][コレクション]または[削除対象条件]が指定されていない場合は無効になります。
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

ありません。

出力スキーマ

ありません。

大容量データ処理

大容量データ処理には対応していません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名 説明 備考
count 削除したドキュメント数が格納されます。
  • デフォルト値はnullです。
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • SkyOnDemandのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • SkyOnDemandのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • SkyOnDemandのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

各オペレーション共通の仕様制限については、「Microsoft Azure DocumentDBアダプタの制限事項」を参照してください。

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]
[接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]
[接続先]で指定したリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。
[<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
com.microsoft.azure.documentdb.DocumentClientException エラーメッセージにより、原因は異なります。 エラーメッセージの内容を確認してください。
DatabaseNotFoundException
データベース[<データベース>]が見つかりません。
[接続先]で指定したデータベースが見つかりません。 [接続先]で指定したグローバルリソースの[データベース]を確認してください。
CollectionNotFoundException
コレクション[<コレクション>]が見つかりません。
[コレクション]で指定したコレクションが見つかりません。 [コレクション]で指定したコレクションを確認してください。

注意事項