レコード一括ダウンロード
目次
機能概要
データベースのレコード情報をtsvファイル（タブ区切のテキスト）またはcsvファイル（カンマ区切のテキスト）でダウンロードできます。
大量のレコード出力を実現する為、レコード出力を依頼し、非同期でファイルをダウンロードします。
ファイルフィールドに登録されているファイルの一括出力は、操作画面上のアプリ利用画面から一括出力することができますので、こちらをご参照ください。
操作画面
1.レコード一覧
レコード一覧画面左上の「歯車」ボタンから「一括ダウンロード（全件）」を選択します。
データベースのレコード全件が出力対象となります。
検索機能を使用している場合、「一括ダウンロード（検索結果）」を選択できます。
ただし、詳細検索の「配信エラー抽出」は「一括ダウンロード（検索結果）」の対象外のためご注意ください。
2.出力ファイルの形式、対象フィールド、タイムゾーン選択
出力ファイルの形式を以下から選択できます。
「TSV」・・・タブ区切のテキスト
「CSV」・・・カンマ区切のテキスト
文字フォーマットにUTF-8(BOM付き)を選択することで、Excelで文字化けせずにファイルを開くことができます。
ヘッダラベルを「識別名」もしくは「表示名」から選択できます。
出力対象フィールドを選択、並び替えできます。
出力ファイル内の「日時フィールド」「作成日時」「最終更新日時」のタイムゾーンを指定できます。
3.ダウンロード画面（ファイル生成中）
レコードの生成が完了するまでは、ファイル生成中のステータスとなります。
データ量が多い場合は生成に時間を要する為、画面記載の所要時間を目安に、一度このモーダルウィンドウを閉じ、時間が経過してから、再度このモーダルウィンドウを開き、ダウンロード状況を確認してください。
なお、モーダルウィンドウを閉じても、生成処理はバックグラウンドで継続されています。
4.ダウンロード画面（ファイル生成完了）
出力処理が完了するとファイルが生成され、ダウンロードできます。
その他
・出力ファイルにはフィールド情報以外にレコードID、登録日時、更新日時が含まれます。
・ファイル容量が多い場合、100MiB単位で分割されます。
・出力されたファイルの保存期間はこちらをご参照ください。当該期間内に新たなファイル生成が完了すると生成済みファイルは上書かれます。
・出力処理は排他の為、生成処理中に新たに生成処理を依頼すると処理中の依頼はキャンセルされます。
・操作画面からの一括ダウンロードではフィールドのフォーマットを指定することができません。フォーマットを指定したい場合はレコード一括出力APIをご利用ください。
・ファイルフィールドに登録したファイル実体は出力されません。対象フィールドにファイルフィールドを指定した場合、生成ファイルにはAPIでのリクエストに使用するファイルURLが出力されます。
・ファイルフィールド実体をダウンロードしたい場合は、以下のいずれかの方法で取得してください。
・アプリ利用画面のファイル一括ダウンロードを使用して、ファイルを含むzipファイルを生成しダウンロードする。
・APIを使用してファイルを取得する。
※ユーザフィールド、パスワードフィールドはダウンロードすることができません。
レコード一括出力APIにおけるフォーマット指定について
APIで一括出力をする場合には、フィールドにはそれぞれ以下のフォーマットが指定できます。
フォーマットを指定することで、指定したフォーマットで一括出力されます。
指定した場合には出力したファイルのヘッダにフォーマット名がパイプ"｜"区切りで記載されます。
例：電話番号にnationalを指定した場合
phone|national
出力：03-5575-6601
internationalを指定した場合
phone|international
出力： +81 3-5575-6601
フォーマットにはデフォルト値があり、省略することも可能です。省略した場合にはファイルのヘッダにはフォーマット名は記載されません。
例：電話番号にフォーマット無指定の場合
phone
出力：+81355756601（E164のフォーマットがデフォルト値になっています）※操作画面で一括出力する場合にはフォーマットの指定はできません。
※タイムゾーンに関しては、recordValueTimeZoneにタイムゾーンを指定するパラメータを付与することで、
日時フィールド、作成日時、最終更新日時を指定したタイムゾーンの時刻に変換して出力することができます。
タイムゾーンの一覧はこちらをご確認ください。
| フィールドタイプ名 | フィールドタイプ名(API) | 指定可能なフォーマット | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| レコード番号 | _id | - | |||||||||||||||||||||||||
| 登録日時 | _createdAt |
|
|||||||||||||||||||||||||
| 更新日時 | _updatedAt |
|
|||||||||||||||||||||||||
| テキスト | text | - | |||||||||||||||||||||||||
| テキストエリア | textarea | - | |||||||||||||||||||||||||
| メールアドレス | - | ||||||||||||||||||||||||||
| 電話番号 | phone |
|
|||||||||||||||||||||||||
| 整数 | integer | - | |||||||||||||||||||||||||
| 数値 | double | - | |||||||||||||||||||||||||
| 日付 | date |
|
|||||||||||||||||||||||||
| 月日 | monthDay |
|
|||||||||||||||||||||||||
| 時刻 | time |
|
|||||||||||||||||||||||||
| 日時 | dateTime |
|
|||||||||||||||||||||||||
| セレクト | select |
|
|||||||||||||||||||||||||
| マルチセレクト | multiselect |
|
|||||||||||||||||||||||||
| ファイル | file |
以下のフォーマットでファイルダウンロードURLが出力されます。
|
|||||||||||||||||||||||||
| 参照フィールド | reference |
参照先レコードの閲覧権限がない場合は サブラベルフィールド値は出力されません。 |
一括出力したファイルをExcelで開くと文字化けする場合
一括出力されたファイルの文字コードはUTF-8ですが、Excelで開くと文字コードをShift-JISと認識して、文字化けする場合があります。
文字フォーマットをUTF-8(BOM付き)に指定することで、ExcelがUTF-8と認識して文字化けを回避できます。
