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

CustomStorage

カスタムストレージを管理するクラス

警告

※ 既にインスタンス化されているものが提供されるのでcustomStorageを使用してアクセスしてください。

詳しくは例を参照してください。

Methods

delete()

delete(fileName): Promise<void>

カスタムストレージ内のファイルを削除します。

備考

削除対象のファイルがカスタムファンクションに存在しない場合、エラーは発生しません。

Parameters

ParameterTypeDescription
fileNamestring削除するファイル名

Returns

Promise<void>

なし

Example

await customStorage.delete('payroll.csv')

upload()

upload(fileName, file): Promise<void>

カスタムストレージへファイルをアップロードします。

カスタムファンクション内で作成したCSVファイル等を、本APIでカスタムストレージへアップロードすることができます。

Parameters

ParameterTypeDescription
fileNamestringアップロードするファイル名
fileBufferアップロードするファイル

Returns

Promise<void>

なし

Example

const file = Buffer.from('従業員ID,給与項目名,金額,基準日\n100000,固定支給,50000,2025/4/1')
await customStorage.upload('payroll.csv', file)

利用上の注意点

アップロード可能なファイル形式は以下の通りです:

拡張子説明
.csvカンマ区切り値ファイル
.tsvタブ区切り値ファイル
.jsonJSON 形式ファイル
.xmlXML 形式ファイル
.txtテキストファイル

ファイルパスの制約

  • フォルダ単位での指定はできません

ファイルサイズの制約

  • 最大ファイルサイズ: 500MB

ファイル名の制約

  • 最大文字数: 100 文字
  • 必須: ファイル名には拡張子が必要です
  • 使用禁止文字: ¥ / : * ? " < > |
  • 同名ファイルの扱い: 既に同じファイル名のファイルが存在する場合、アップロードはエラーとなります(上書き保存はできません)
同名ファイルを更新したい場合

既存のファイルを新しいファイルで更新したい場合は、まず既存ファイルを削除してから新しいファイルをアップロードしてください。

// 既存ファイルを削除
await customStorage.delete('payroll.csv')
// 新しいファイルをアップロード
await customStorage.upload('payroll.csv', newFile)
注意

重要なファイルを更新する場合は、事前にバックアップを取ることをお勧めします。