Supabase.Storage.Object (supabase_storage v0.4.2)

Represents an Object within a Supabase Storage Bucket.

This module encapsulates the structure and operations related to an object or file stored within a Supabase Storage bucket.

Structure

An Object has the following attributes:

  • id: The unique identifier for the object.
  • path: The path to the object within its storage bucket.
  • bucket_id: The ID of the bucket that houses this object.
  • name: The name or title of the object.
  • owner: The owner or uploader of the object.
  • metadata: A map containing meta-information about the object (e.g., file type, size).
  • created_at: Timestamp indicating when the object was first uploaded or created.
  • updated_at: Timestamp indicating the last time the object was updated.
  • last_accessed_at: Timestamp of when the object was last accessed or retrieved.

Functions

  • parse!/1: Accepts a map of attributes and constructs a structured Object.

Examples

Parsing an object 

object_attrs = %{
  id: "obj_id",
  path: "/folder/my_file.txt",
  bucket_id: "bucket_123",
  ...
}
Supabase.Storage.Object.parse!(object_attrs)

Summary

Types

t()

Functions

parse(attrs)

Types

t()

@type t() :: %Supabase.Storage.Object{
  bucket_id: String.t(),
  created_at: NaiveDateTime.t(),
  id: String.t(),
  last_accessed_at: NaiveDateTime.t(),
  metadata: map(),
  name: String.t(),
  owner: String.t(),
  path: Path.t(),
  updated_at: NaiveDateTime.t()
}

Functions

parse(attrs)

@spec parse(map() | [map()]) :: {:ok, t() | [t()]} | {:error, Ecto.Changeset.t()}