Entity API
Avgidea Storage と外部データベースやストレージ間でデータの転送が行えます。ストレージの場合、オブジェクト（ファイル）ベースでデータは転送され、データベースの場合、テーブル内のレコードを CSV ファイルとして出力またはテーブルにロードが行えます。
接続先のデータベースやストレージはあらかじめデータソースとして ADP に登録されている必要があります。
共通パラメータ
% curl -X POST -H 'content-type: application/json' -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"entity", "action":"<action>" ... }' https://<endpoint url>
パラメータ
accesskey : アクセスキー
secret：シークレットキー
component : entity
action : 実行するアクション
endpoint url : API リクエスト送信先 URL
- ストレージ間でのオブジェクトのコピー
ストレージ間で特定のオブジェクトや条件に合致するオブジェクト群をコピーすることができます。
a. ストレージ間でのファイルコピー（単一ファイル）
% curl -X POST -H 'content-type: application/json' -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"entity", "action":"transfer", "from":"as1", "to":"as2", "object":"data.csv"}' https://<endpoint url>
{"data":"Transferred successfully","status":"success"}
パラメータ
action : transfer
from : コピー元ストレージのデータソース
to : コピー先ストレージのデータソース
object : コピー元データソース内のオブジェクト名
戻り値
data : データコピー時のメッセージとステータス
b. ストレージ間でのファイルコピー（複数ファイル）
% curl -X POST -H 'content-type: application/json' -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"entity", "action":"transfer", "from":"as1", "to":"as2", "filter":"data"}' https://<endpoint url>
{"data":"Transferred successfully","status":"success"}
パラメータ
action : transfer
from : コピー元ストレージのデータソース
to : コピー先ストレージのデータソース
filter : オブジェクト名に指定文字列を含むオブジェクトをコピー
戻り値
data : データコピー時のメッセージとステータス
2. ストレージからデータベースへの CSV ファイルのロード
ストレージ内の CSV ファイルを直接データベースのテーブルにロードすることができます。
CSV ファイルのロード
% curl -X POST -H 'content-type: application/json' -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"entity", "action":"transfer", "from":"as1", "to":"orcl", "object":"employee.csv", "table":"employees" "worker":4}' https://<endpoint url>
{"data":"Transferred successfully","status":"success"}
パラメータ
action : transfer
from : ストレージのデータソース名
to : データベースのデータソース名
object : データベースへロードするストレージ内の CSV ファイル
table : ロード先のテーブル名
worker : データロード時の並列数
戻り値
data : データコピー時のメッセージとステータス
3. データベースから CSV ファイルの出力
データベース内のテーブルを CSV ファイルとしてストレージに出力することができます。
CSV ファイルの出力
% curl -X POST -H 'content-type: application/json' -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"entity", "action":"transfer", "from":"orcl", "to":"as1", "table":"employees", "table":"employees"}' https://<endpoint url>
{"data":"Transferred successfully","status":"success"}
パラメータ
action : transfer
from : データベースのデータソース名
to : ストレージのデータソース名
table : 出力対象のテーブル名
戻り値
data : データコピー時のメッセージとステータス