メインコンテンツまでスキップ

record export

exportコマンドは、指定されたKintoneアプリからレコードデータをエクスポートします。

例​

cli-kintone record export \
  --base-url https://${yourDomain} \
  --api-token ${apiToken} \
  --app ${kintoneAppId} \
> ${filepath}

オプション​

共通オプションについては、オプションページをご覧ください。

オプション必須説明
--appはいアプリのID
--attachments-dir添付ファイルディレクトリ
--condition、-cクエリ文字列
--order-byクエリとしてのソート順
--fieldsカンマ区切りでエクスポートするフィールド
--encoding 文字エンコーディング
デフォルト：utf8
エンコーディング：utf8およびsjis

注意​

  • テーブル内のフィールドはfieldsオプションに指定できません。

--conditionおよび--order-byオプション​

--conditionおよび--order-byオプションを使用してレコードをフィルタリングおよび並べ替えることができます。

これらのオプションは、@kintone/rest-api-clientのgetAllRecords()に渡されます。

詳細は、getAllRecords()のドキュメントをご参照ください。

添付ファイルのダウンロード​

--attachments-dirオプションが設定されている場合、添付ファイルはローカルディレクトリにダウンロードされます。

  • ファイルパスは<attachmentsDir>/<fieldCode>-<recordId>/<filename>です。
    • テーブル内の添付フィールドの場合、ファイルパスは<attachmentsDir>/<fieldCode>-<recordId>-<tableRowIndex>/<filename>です。
  • 同じ添付フィールド内で同じ名前のファイルがある場合、ファイルは<filename> (<index>).<ext>にリネームされます。