bentenコマンド
- bentenコマンドでは引数の指定により、以下に示す様々なコマンドが実行できます。
- コマンドには共通利用の用途と、データ登録時に利用するもので分類されます。
- 詳しくはヘルプコマンドを参考ください。
- それぞれのコマンドの説明は下記の各リンクを参照ください。
Warning
データ登録用コマンドはデータ登録用グループアカウント(ビームラインアカウント等)で実行する必要があります。
共通利用
| 位置引数名 | 用途 | 備考 |
|---|---|---|
| init | 初期設定 (接続するbenten-agentサーバの設定) | |
| login | ログイン認証 | |
| logout | ログアウト | |
| refresh_token | アクセストークンの更新 | login時に取得したアクセストークンは期限(1日)があります; 1日以上認証継続する際には、本コマンドを利用して認証期限を延長します |
| userinfo | ログインしたユーザーの属性情報を取得 | |
| directories | ディレクトリ検索 | |
| files | ファイル検索 | |
| register_names | 登録名の検索 | |
| metadata | メタデータを取得 | |
| metadata_mappings | メタデータのマッピング情報を取得 | |
| metadata_keys | メタデータのキーリストを取得 | |
| proposal | 課題番号の検索 | |
| proposal_meta | 課題番号に紐づくメタデータを参照 | |
| download | 複数ファイルのダウンロード | |
| download_file | 単一ファイルダウンロード | |
| download_zip | 複数ファイルのダウンロードを | 複数ファイルをzipファイルで纏めてダウンロードします |
| download_zip_queue | download_zip指令のqueueを確認 | 本コマンドをユーザーが直接利用する機会はありません: 非同期で実行されるdownload_zipのjobの状態 (queue)を確認します |
| download_zip_file | donwload_zipで生成したZIPファイルをダウンロード | 本コマンドをユーザーが直接利用する機会はありません; download_zipのjob終了を確認した後、ZIPファイルダウンロードを行います |
データ登録用
| 位置引数名 | 用途 | 備考 |
|---|---|---|
| init_storage | ローカルストレージパス及びディスク名の設定 | |
| init_index | データ登録時に用いる index生成 | 本コマンドをユーザーが利用する必要はありません |
| config | データ登録の設定情報の確認 | |
| proposal_number | データ登録時に必要となる課題番号の設定 | 本コマンドで課題番号を設定した際は、メタデータ作成時の課題番設定において自動補完がおこなわれます |
| list | ファイルリスト(データ登録状況情報を付加)を確認 | |
| meta | メタデータを参照 | |
| create_meta_system | システム用メタデータを生成 | |
| commit | ファイルアップロート及びメタデータ登録 | 内部で upload および register コマンドの両方を呼び出します |
| upload | ファイルアップロード | システム用メタデータが生成されていない際に、create_meta_systemコマンドを呼び出します |
| reset_upload | アップロードされたファイルのデータをリセット | |
| register | メタデータ登録、及びアップロードされたファイルの登録 | |
| restore | リポジトリからローカルストレージへとデータを復帰(登録名を指定) | |
| remove | リポジトリのデータを一部消去(登録名を指定) | リポジトリとローカルストレージにあるデータを比較して、ローカルストレージ側にないファイルをリポジトリ側で消去します |
| delete | リポジトリのデータを全消去(登録名を指定) |