ver.2サポートサイト

HOME機能アプリ利用レコードレコード一括ダウンロード

レコード一括ダウンロード

機能概要

データベースのレコード情報をtsvファイル(タブ区切のテキスト)またはcsvファイル(カンマ区切のテキスト)でダウンロードできます。
大量のレコード出力を実現する為、レコード出力を依頼し、非同期でファイルをダウンロードします。

 

操作画面

1.レコード一覧

レコード一覧画面左上の「歯車」ボタンから「一括ダウンロード(全件)」を選択します。
データベースのレコード全件が出力対象となります。

 

2.出力ファイルの形式選択

出力ファイルの形式を以下から選択できます。
 「TSV」・・・タブ区切のテキスト
 「CSV」・・・カンマ区切のテキスト

文字フォーマットにUTF-8(BOM付き)を選択することで、Excelで文字化けせずにファイルを開くことができます。

3.ダウンロード画面(ファイル生成中)

レコードの生成が完了するまでは、ファイル生成中のステータスとなります。
データ量が多い場合は生成に時間を要する為、画面記載の所要時間を目安に、一度このモーダルウィンドウを閉じ、時間が経過してから、再度このモーダルウィンドウを開き、ダウンロード状況を確認してください。
なお、モーダルウィンドウを閉じても、生成処理はバックグラウンドで継続されています。

 

4.ダウンロード画面(ファイル生成完了)

出力処理が完了するとファイルが生成され、ダウンロードできます。

 

その他

・出力ファイルにはフィールド情報以外にレコードID、登録日時、更新日時が含まれます。
・ファイル容量が多い場合、100MiB単位で分割されます。
・出力されたファイルの保存期間はこちらをご参照ください。当該期間内に新たなファイル生成が完了すると生成済みファイルは上書かれます。
・出力処理は排他の為、生成処理中に新たに生成処理を依頼すると処理中の依頼はキャンセルされます。

 

レコード一括出力APIにおけるフォーマット指定について

APIで一括出力をする場合には、フィールドにはそれぞれ以下のフォーマットが指定できます。

フォーマットを指定することで、指定したフォーマットで一括出力されます。

指定した場合には出力したファイルのヘッダにフォーマット名がパイプ"|"区切りで記載されます。

例:電話番号にnationalを指定した場合
phone|national
出力:03-5575-6601

internationalを指定した場合
phone|international
出力: +81 3-5575-6601

 

フォーマットにはデフォルト値があり、省略することも可能です。省略した場合にはファイルのヘッダにはフォーマット名は記載されません。

例:電話番号にフォーマット無指定の場合
phone
出力:+81355756601(E164のフォーマットがデフォルト値になっています)

※操作画面で一括出力する場合にはフォーマットの指定はできません。

※timezoneフォーマットに関してはVer.2.7.1(2019年8月現在)ではUTCタイムゾーンである"Z"のみが出力されます。

 

フィールドタイプ名 フィールドタイプ名(API) 指定可能なフォーマット
レコード番号 _id -
登録日時 _createdAt
フォーマット サンプル
dateTime(デフォルト)

2017-01-01T01:15:30Z

date 2017-01-01
year 2017
month 1
day 1
time 01:15:30
hour 1
minute 15
second 30
timezone Z
更新日時 _updatedAt
フォーマット サンプル
dateTime(デフォルト) 2017-01-01T01:15:30Z
date 2017-01-01
year 2017
month 1
day 1
time 01:15:30
hour 1
minute 15
second 30
timezone Z
テキスト text
フォーマット サンプル
allowNewLine(デフォルト) test,
test
excludeNewLine test,test
メールアドレス email -
電話番号 phone
フォーマット サンプル
E164(デフォルト) +81355756601
international +81 3-5575-6601
national 03-5575-6601
整数 integer -
数値 double -
日付 date
フォーマット サンプル
date(デフォルト) 2017-01-31
year 2017
month 1
day 31
月日 monthDay
フォーマット サンプル
monthDay(デフォルト) 01-31
month 1
day 31
時刻 time
フォーマット サンプル
time(デフォルト) 01:15:30
hour 1
minute 15
second 30
日時 dateTime
フォーマット サンプル
dateTime(デフォルト) 2017-01-01T01:15:30Z
date 2017-01-01
year 2017
month 1
day 1
time 01:15:30
hour 1
minute 15
second 30
timezone Z
セレクト select
フォーマット サンプル
label(デフォルト) test
id 1
マルチセレクト multiselect
フォーマット サンプル
label(デフォルト) test1|test2
id 1|2
ファイル file

-

ファイルキーが出力されます
(ファイル自体は出力されません)

参照フィールド reference
ヘッダータイプ フォーマット ヘッダサンプル フォーマットサンプル
name label

{参照フィールド識別名}.{ラベルフィールド識別名}

favoriteShop.shopName

赤坂店|青山店|(_unauthorized:15)|下北沢店
id

{参照フィールド識別名}._id

favoriteShop._id

1|3|15|42
displayName label

{参照フィールド表示名}({ラベルフィールド表示名})

お気に入り店舗(店舗名)

赤坂店|青山店|(_unauthorized:15)|下北沢店
id

{参照フィールド表示名}(ID)

お気に入り店舗(ID)

1|3|15|42
fieldId label

{参照フィールドID}.{ラベルフィールドID}

3.2

赤坂店|青山店|(_unauthorized:15)|下北沢店
id

{参照フィールドID}._id

3._id

1|3|15|42

参照先レコードの閲覧権限がない場合は(_unauthorized:XX)で出力します。

一括出力したファイルをExcelで開くと文字化けする場合

一括出力されたファイルの文字コードはUTF-8ですが、Excelで開くと文字コードをShift-JISと認識して、文字化けする場合があります。

文字フォーマットをUTF-8(BOM付き)に指定することで、ExcelがUTF-8と認識して文字化けを回避できます。