項目取得(スキャン)

オペレーション名

項目取得(スキャン)

機能概要

Amazon DynamoDBのテーブルに格納されている項目を取得します。

本オペレーションではScan APIを使用します。API仕様については以下のページを参照してください。

データモデル

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

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
テーブル名 必須 使用可 読み取るテーブルの名前を選択または入力します。  
インデックス名 必須 使用可 読み取るインデックスの名前を選択または入力します。  
属性一覧 必須 - [インデックス名]で指定したインデックスの属性一覧を指定します。
追加した行は読み取り対象カラムとなります。

各読み取り対象カラムは以下のボタンで操作することができます。
  • [追加]:
    読み取り対象カラムを追加します。
  • [上へ]:
    選択している読み取り対象カラムの順序を一つ上に上げます。
  • [下へ]:
    選択している読み取り対象カラムの順序を一つ下に下げます。
  • [削除]:
    読み取り対象カラムを削除します。
 
属性一覧/ハッシュキー 省略可 使用不可 [テーブル名]で指定したテーブル、または[インデックス名]で指定したインデックスのハッシュキー属性かどうかが表示されます。  
属性一覧/レンジキー 省略可 使用不可 [テーブル名]で指定したテーブル、または[インデックス名]で指定したインデックスのレンジキー属性かどうかが表示されます。  
属性一覧/属性名 必須 使用可 [テーブル名]で指定したテーブルの属性名、または[インデックス名]で指定したインデックスの属性名を入力します。
  • 指定した属性名がMapperのスキーマに表示されます。
属性一覧/型 必須 使用不可 [属性名]の型を選択します。
  • 「<DynamoDBデータ型> (<内部データ型>)」形式で表示されます。
    • DynamoDBデータ型:
      Amazon DynamoDBでサポートされるデータ型です。
    • 内部データ型:
      DataSpider Cloud内部で使用しているデータ型です。
      詳細については、「内部データ型」を参照してください。
プロパティアクション
項目名 説明 備考
テーブル名一覧の更新 指定した接続先にあるテーブル名を取得して、[テーブル名]に設定します。  
インデクス名一覧の更新 指定したテーブルに設定されているインデックスを取得して、[インデックス名]に設定します。  
属性一覧を更新する [インデックス名]で指定したインデックスの属性一覧を更新します。
  • [インデックス名]を指定した場合、有効になります。
  • [テーブル名]で指定したテーブル、または[インデックス名]で指定したインデックスに対してスキャンを実行して取得した項目から属性名とデータ型を抽出します。
  • スキャンによって取得した項目に、サポートしていないDynamoDBデータ型の属性が存在している場合、その属性は属性一覧に追加されません。
  • サポートする型については、「Amazon DynamoDBアダプタの制限事項」を参照してください。
  • [テーブル名]で指定したテーブルに項目が存在しない場合、プライマリキー属性のみ設定します。
    また、データ型は実際の属性の型に関わらず[String (String)]を設定します。
読み取り設定
項目名 必須/省略可 変数の使用 説明 備考
実際の型と属性一覧の型が異なる行をスキップする 省略可 使用不可 [属性一覧/型]で指定した型と、実際に取得した型が異なる場合、その項目をスキップするかどうかを選択します。
  • [チェックあり]:
    [属性一覧/型]で指定した型と、実際に取得した型が異なる場合、その項目をスキップします。
  • [チェックなし]:(デフォルト)
    [属性一覧/型]で指定した型と、実際に取得した型が異なる場合、UnexpectedDynamoDBDataTypeExceptionが発生します。
  • スキップした項目の情報はスクリプトの実行ログに出力されます。
データ処理方式
項目名 必須/省略可 変数の使用 説明 備考
データ処理方式 必須 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
 
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

ありません。

出力スキーマ

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

Mapperでのスキーマ読み込み

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

大容量データ処理

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

PSPでの使用について

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

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

コンポーネント変数名 説明 備考
count 取得した項目の件数が格納されます。
  • デフォルト値はnullです。
skip_count 属性一覧で指定した型と実際の型が異なる場合に項目をスキップした件数が格納されます。
  • デフォルト値はnullです。
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のバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

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

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]
[接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]
[接続先]で指定したリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。
[<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
UnexpectedDynamoDBDataTypeException
データ型が異なります。
[属性一覧/型]で指定した型と実際に取得した属性の型が異なります。 テーブルに存在する属性のデータ型を揃えるか、[実際の型と属性一覧の型が異なる行をスキップする]にチェックを入れると、例外の発生を抑制することができます。

注意事項