ver.2サポートサイト

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

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

機能概要

データベースのレコード情報をtsvファイル（タブ区切のテキスト）またはcsvファイル（カンマ区切のテキスト）でダウンロードできます。

大量のレコード出力を実現する為、レコード出力を依頼し、非同期でファイルをダウンロードします。

ファイルフィールドに登録されているファイルはアプリ利用画面のファイル一括ダウンロードより一括出力することができます。

機能仕様

・出力ファイルにはフィールド情報以外にレコードID、登録日時、更新日時が含まれます。

・ユーザフィールド、パスワードフィールドはダウンロードすることができません。
・ファイル容量が多い場合、100MiB単位で分割されます。
・出力されたファイルの保存期間はこちらをご参照ください。当該期間内に新たなファイル生成が完了すると生成済みファイルは上書かれます。
・出力処理は排他の為、生成処理中に新たに生成処理を依頼すると処理中の依頼はキャンセルされます。

ファイルフィールド

・ファイルフィールドに登録したファイル実体は出力されません。

　対象フィールドにファイルフィールドを指定した場合、生成ファイルにはAPIでのリクエストに使用するファイルURLが出力されます。
・ファイルフィールド実体をダウンロードしたい場合は、以下のいずれかの方法で取得してください。
　・アプリ利用画面のファイル一括ダウンロードを使用して、ファイルを含むzipファイルを生成しダウンロードする
　・APIを使用してファイルを取得する

フィールドのフォーマット指定

・操作画面からの一括ダウンロードでは電話番号フィールドのみフォーマットを指定することができます。

　電話番号以外のフォーマットを指定したい場合はレコード一覧を取得API/レコードを取得APIまたはレコード一括出力依頼APIをご利用ください。

　機能ごとにフォーマット指定可能なフィールドタイプについては以下の表をご参照ください。

レコード一括ダウンロード レコード一覧を取得API
レコードを取得API		 レコード一括出力依頼API

フォーマット指定可能な

フィールドタイプ

 電話番号 セレクト、マルチセレクト 登録日時、更新日時、電話番号、日付、月日、時刻、日時、セレクト、マルチセレクト、参照フィールド
ダウンロード一覧

・ダウンロード一覧には、同一ブラウザタブで行ったダウンロードが表示されます。

　別ブラウザや別タブ間のダウンロード情報は表示されません。
・以下の条件の時、ダウンロード一覧から削除され表示されなくなります。
　・ダウンロード完了、エラー、キャンセル後およそ10分経過した時
　・リロードやブラウザを閉じるなどの画面離脱に当たる操作を行った場合
　・アプリ利用以外の画面へ遷移した場合
　・ログアウトを行った場合

UI：一括ダウンロード

1.レコード一覧

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

 

検索機能を使用することで、フィールドごとに条件を指定しレコードをフィルタリングすることも可能です。

詳しくはアプリ利用画面のレコード詳細検索をご参照ください。

検索機能を使用している場合、「一括ダウンロード（検索結果）」を選択できます。

2.出力ファイルの形式、対象フィールド、タイムゾーン選択

説明
ファイルフォーマット 出力ファイルの形式を以下から選択できます。
　TSV：タブ区切のテキスト
　CSV：カンマ区切のテキスト
文字フォーマット 文字フォーマットにUTF-8(BOM付き)を選択することで、Excelで文字化けせずにファイルを開くことができます。
ヘッダラベル ヘッダラベルを「識別名」もしくは「表示名」から選択できます。
対象フィールド

出力対象のフィールドは、任意に選択および並び替えを行うことができます。

電話番号フィールドについて、許可国コードが日本（+81）に設定されている場合は、指定した電話番号フォーマットを適用した形式でダウンロードされます。
ファイルを出力した際、電話番号フィールドのヘッダには、指定したフォーマット名がパイプ"｜"区切りで付加されます。
なお、許可国コードに日本（+81）以外が設定されている場合は、「国際形式（ハイフンなし）」のフォーマットでダウンロードされます。

・電話番号フィールドダウンロードデータ例

フォーマットの指定 日本国内形式 国際形式（ハイフンあり）

国際形式（ハイフンなし）

※デフォルト
出力されるヘッダ phone|national phone|international phone|E164
出力される値 03-5575-6601 +81 3-5575-6601 +81355756601
タイムゾーン 出力ファイル内の「日時フィールド」「作成日時」「最終更新日時」のタイムゾーンを指定できます。

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

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

 

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

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

5.ダウンロード一覧（ファイルのダウンロード履歴）

ダウンロード終了後、ダウンロード一覧からレコード一括ダウンロード/ファイル一括ダウンロードのダウンロード履歴が確認できます。

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

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

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

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

レコード一括出力依頼APIでは、フィールドのフォーマットを指定してデータベースのレコード情報を一括出力できます。
フォーマットを指定する場合は、リクエストのfieldsからフォーマットを指定します。
フォーマットにはデフォルト値があり、省略することも可能です。

機能ごとにフォーマット指定可能なフィールドタイプについては機能仕様をご参照ください。

出力フォーマットについてはフィールドタイプリファレンスをご参照ください。

 

出力ファイルのヘッダについて
フォーマットを指定すると出力したファイルのヘッダにフォーマット名がパイプ"｜"区切りで記載されます。

フォーマットの指定を省略した場合はファイルのヘッダにフォーマット名は記載されません。

・電話番号フィールド出力ファイル例

フォーマットの指定 national international E164 指定なし
出力されるヘッダ phone|national phone|international phone|E164 phone
出力される値 03-5575-6601 +81 3-5575-6601 +81355756601 +81355756601

レコード一括出力APIで指定可能なフォーマット

フィールドにはそれぞれ以下のフォーマットが指定できます。

フィールドタイプ名 フィールドタイプ名(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 -
テキストエリア textarea -
メールアドレス 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

以下のフォーマットでファイルダウンロードURLが出力されます。

https://api.spiral-platform.com/v1/apps/{アプリID}/dbs/{DBID}/{フィールドID}/{レコードID}/files/{ファイルキー}/download
参照フィールド 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)で出力します。

サブラベルフィールド値は出力されません。

タイムゾーンについて

recordValueTimeZoneにタイムゾーンを指定するパラメータを付与することで
日時フィールド、作成日時、最終更新日時を指定したタイムゾーンの時刻に変換して出力することができます。

タイムゾーンの一覧はこちらをご確認ください。