Supabase.Storage.SearchOptions (supabase_storage v0.4.0)

Represents the search options for querying objects within Supabase Storage.

This module encapsulates various options that aid in fetching and sorting storage objects. These options include specifying the limit on the number of results, an offset for pagination, and a sorting directive.

Summary

Types

t()

An SearchOptions consists of the following attributes

Types

t()

@type t() :: %Supabase.Storage.SearchOptions{
  limit: integer(),
  offset: integer(),
  search: String.t(),
  sort_by: %Supabase.Storage.SearchOptions.SortBy{
    column: String.t(),
    order: String.t()
  }
}

An SearchOptions consists of the following attributes:

  • limit: The number of files you want to be returned.
  • offset: The starting position.
  • sort_by: The column to sort by. Can be any column inside a Supabase.Storage.File.
  • search: The search string to filter files by.

Functions

parse(attrs)

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