SQLによるドキュメント読み取り処理

オペレーション名

SQLによるドキュメント読み取り

機能概要

任意のSQL文を使用して、Microsoft Azure DocumentDBのコレクションに格納されているドキュメントを取得します。

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
コレクション 必須 使用可 読み取るコレクションの名前を選択または入力します。  
SQL文 必須 使用可 ドキュメントを取得するSQL文を入力します。
  • デフォルト値は「SELECT TOP 100 * FROM c」です。このSQL文では、項目を限定せず100件を上限に取得します。
  • DocumentDBにおけるSQLについては以下のページを参照してください。
    • 「DocumentDB 内の SQL クエリ」-(https://azure.microsoft.com/ja-jp/documentation/articles/documentdb-sql-query/)
    • 「DocumentDB SQL クエリ言語」-(https://msdn.microsoft.com/library/azure/dn782250.aspx)
スキーマ定義 必須 - [コレクション]で指定したコレクションの項目一覧を指定します。
追加した行は読み取り対象項目となります。

各読み取り対象項目は以下のボタンで操作することができます。
  • [追加]:
    読み取り対象項目を追加します。
  • [上へ]:
    選択している読み取り対象項目の順序を一つ上に上げます。
  • [下へ]:
    選択している読み取り対象項目の順序を一つ下に下げます。
  • [削除]:
    読み取り対象項目を削除します。
 
スキーマ定義/項目名 必須 使用可 [コレクション]で指定したコレクションの項目名を入力します。
  • 指定した項目名がMapperのスキーマに表示されます。
スキーマ定義/型 必須 使用不可 [項目名]の型を選択します。
プロパティアクション
項目名 説明 備考
コレクション一覧の更新 指定した接続先からコレクションを取得して、[コレクション]に設定します。  
テスト実行 指定したSQL文を実行します。
  • [接続先][コレクション]または[SQL文]が指定されていない場合は無効になります。
SQL文を実行してスキーマを設定 指定したコレクションにSQL文を実行し、抽出結果から型情報を取得して[スキーマ定義]に設定します。
  • [コレクション]で指定したコレクションへ[SQL文]で指定したSQLを実行して100件を取得し、項目名と型を抽出します。
    • コレクションにドキュメントが1件以上登録されている必要があります。
  • 項目の型情報を判定できない場合、またはサポートしていない型の場合は、その項目の型は空欄になります。
  • [接続先][コレクション]または[SQL文]が指定されていない場合は無効になります。
データ処理方式
項目名 必須/省略可 変数の使用 説明 備考
データ処理方式 必須 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
 
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

ありません。

出力スキーマ

[属性一覧]の設定により、カラム数が異なります。
スキーマ構造については、「テーブルモデル型のスキーマ」を参照してください。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

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

PSPでの使用について

PSPで使用できます。
PSPについては、「パラレルストリーミング処理」を参照してください。

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

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

仕様制限

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

主な例外

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

注意事項