View Source Lightning.Collections (Lightning v2.10.4)

Access to collections of unique key-value pairs shared across multiple workflows.

Summary

Functions

create_collection(attrs)

Creates a new collection with the given attributes.

create_collection(project_id, name)

delete(map, key)

delete_all(map, key_pattern \\ nil)

delete_collection(collection_id)

get(map, key)

get_all(map, params, key_pattern \\ nil)

get_collection(name)

list_collections(opts \\ [])

Returns the list of collections with optional ordering and preloading.

put(map, key, value)

put_all(map, kv_list)

update_collection(collection, attrs)

Updates an existing collection with the given attributes.

Functions

create_collection(attrs)

@spec create_collection(map()) ::
  {:ok, Lightning.Collections.Collection.t()} | {:error, Ecto.Changeset.t()}

Creates a new collection with the given attributes.

Parameters

attrs: A map of attributes to create the collection.

Examples

iex> create_collection(%{name: "New Collection", description: "Description here"})
{:ok, %Collection{}}

iex> create_collection(%{name: nil})
{:error, %Ecto.Changeset{}}

Returns

{:ok, %Collection{}} on success.
{:error, %Ecto.Changeset{}} on failure due to validation errors.

create_collection(project_id, name)

@spec create_collection(Ecto.UUID.t(), String.t()) ::
  {:ok, Lightning.Collections.Collection.t()} | {:error, Ecto.Changeset.t()}

delete(map, key)

@spec delete(Lightning.Collections.Collection.t(), String.t()) ::
  :ok | {:error, :not_found}

delete_all(map, key_pattern \\ nil)

@spec delete_all(Lightning.Collections.Collection.t(), String.t() | nil) ::
  {:ok, non_neg_integer()}

delete_collection(collection_id)

@spec delete_collection(Ecto.UUID.t()) ::
  {:ok, Lightning.Collections.Collection.t()}
  | {:error, Ecto.Changeset.t()}
  | {:error, :not_found}

get(map, key)

@spec get(Lightning.Collections.Collection.t(), String.t()) ::
  Lightning.Collections.Item.t() | nil

get_all(map, params, key_pattern \\ nil)

@spec get_all(Lightning.Collections.Collection.t(), Enum.t(), String.t() | nil) ::
  Enum.t()

get_collection(name)

@spec get_collection(String.t()) ::
  {:ok, Lightning.Collections.Collection.t()} | {:error, :not_found}

list_collections(opts \\ [])

@spec list_collections(keyword()) :: [Lightning.Collections.Collection.t()]

Returns the list of collections with optional ordering and preloading.

Parameters

opts: A keyword list of options.
- :order_by (optional): The field by which to order the results. Default is [asc: :name].
- :preload (optional): A list of associations to preload. Default is [:project].

Examples

iex> list_collections()
[%Collection{}, ...]

iex> list_collections(order_by: [asc: :inserted_at], preload: [:project, :user])
[%Collection{}, ...]

Returns

A list of %Collection{} structs, preloaded and ordered as specified.

put(map, key, value)

@spec put(Lightning.Collections.Collection.t(), String.t(), String.t()) ::
  :ok | {:error, Ecto.Changeset.t()}

put_all(map, kv_list)

@spec put_all(Lightning.Collections.Collection.t(), [{String.t(), String.t()}]) ::
  {:ok, non_neg_integer()}

update_collection(collection, attrs)

@spec update_collection(Lightning.Collections.Collection.t(), map()) ::
  {:ok, Lightning.Collections.Collection.t()} | {:error, Ecto.Changeset.t()}

Updates an existing collection with the given attributes.

Parameters

collection: The existing %Collection{} struct to update.
attrs: A map of attributes to update the collection.

Examples

iex> update_collection(collection, %{name: "Updated Name"})
{:ok, %Collection{}}

iex> update_collection(collection, %{name: nil})
{:error, %Ecto.Changeset{}}

Returns

{:ok, %Collection{}} on success.
{:error, %Ecto.Changeset{}} on failure due to validation errors.