Search documentation of phoenix_kit

# PhoenixKit.Modules.Storage.Manager (phoenix_kit v1.7.87)

Copy Markdown View Source

Storage manager for handling file operations with redundancy and failover.

This module coordinates file storage across multiple buckets with automatic redundancy, failover, and variant generation.

## Summary

### Functions

delete_file(file_path, opts \\ [])

Deletes a file from all storage buckets.

file_exists?(file_path, opts \\ [])

Checks if a file exists in any storage bucket.

get_file_access(file_name)

Returns file access info based on bucket access_type.

get_local_file_path(file_path)

Returns the local filesystem path for a file if stored locally.

public_url(file_path, opts \\ [])

Gets a public URL for a file from the highest priority bucket that has it.

retrieve_file(file_path, opts \\ [])

Retrieves a file from storage with failover.

store_file(source_path, opts \\ [])

Stores a file across multiple buckets based on redundancy settings.

## Functions

# delete_file(file_path, opts \\ [])

Deletes a file from all storage buckets.

# file_exists?(file_path, opts \\ [])

Checks if a file exists in any storage bucket.

# get_file_access(file_name)

Returns file access info based on bucket access_type.

Determines how a file should be served based on its storage location:

- Local files are always served directly
- Remote files depend on bucket's access_type setting

## Returns

- `{:local, path}` - File is local, serve directly from filesystem
- `{:redirect, url}` - Redirect to public URL (for public buckets)
- `{:proxy, file_name}` - Download and proxy through server (for private buckets)
- `{:error, :not_found}` - File not found in any bucket

# get_local_file_path(file_path)

Returns the local filesystem path for a file if stored locally.

This function checks enabled buckets with "local" provider and returns the direct path to the file if it exists. This allows serving files directly without copying to a temp file first.

## Returns

- `{:ok, path}` - File exists at the local path
- `{:error, :not_local}` - No local bucket contains the file

# public_url(file_path, opts \\ [])

Gets a public URL for a file from the highest priority bucket that has it.

# retrieve_file(file_path, opts \\ [])

Retrieves a file from storage with failover.

Tries each bucket in priority order until the file is found.

# store_file(source_path, opts \\ [])

Stores a file across multiple buckets based on redundancy settings.

## Options

- `:redundancy_copies` - Number of copies to store (default: from settings)
- `:priority_buckets` - List of specific bucket IDs to use (default: auto-select)
- `:force_bucket_ids` - List of specific bucket IDs to use (overrides priority_buckets)
- `:generate_variants` - Whether to generate variants (default: from settings)

## Returns

- `{:ok, file_result}` - File stored successfully with locations
- `{:error, reason}` - Failed to store file