View Source EctoShorts.Actions (ecto_shorts v2.2.1)

Actions for CRUD in ecto, these can be used by all schemas/queries

Link to this section Summary

Functions

Gets a collection of schemas from the database

Gets a collection of schemas from the database but allows for a filter or an options list.

Similar to all/2 but can also accept a keyword options list.

Creates a schema with given params. Can also accept a keyword options list.

Deletes a schema

Similar to delete/1 but can also accept a keyword options list.

Deletes a schema. Can also accept a keyword options list.

Finds a schema with matching params. Can also accept a keyword options list.

Finds a schema by params and updates it or creates with results of params/update_params merged. Can also accept a keyword options list.

Finds a schema by params and updates it or creates with results of params/update_params merged. Can also accept a keyword options list.

Finds a schema by params or creates one if it isn't found. Can also accept a keyword options list.

Accepts a list of schemas and attempts to find them in the DB. Any missing Schemas will be created. Can also accept a keyword options list.

Gets a schema from the database

Gets a collection of schemas from the database but allows for a filter

Updates a schema with given updates. Can also accept a keyword options list.

Link to this section Types

Specs

aggregate_options() :: :avg | :count | :max | :min | :sum

Specs

filter_params() :: Keyword.t() | map()

Specs

id() :: pos_integer()

Specs

opts() :: Keyword.t()

Specs

query() :: Ecto.Query | Ecto.Schema

Specs

schema() :: Ecto.Schema.t() | module()

Specs

schema_data() :: Ecto.Schema.t()

Specs

schema_list() :: [Ecto.Schema.t()]

Specs

schema_res() :: {:ok, Ecto.Schema.t()} | {:error, any()}

Specs

updates() :: map() | Keyword.t()

Link to this section Functions

Link to this function

aggregate(schema, params, aggregate, field, opts \\ [])

View Source

Specs

aggregate(
  queryable :: query(),
  params :: filter_params(),
  agg_opts :: aggregate_options(),
  field :: atom(),
  opts()
) :: term()

Specs

all(queryable :: query()) :: schema_list()

Gets a collection of schemas from the database

examples

Examples

iex> EctoSchemas.Actions.all(EctoSchemas.Accounts.User)
[]

Specs

all(queryable :: query(), filter_params() | opts()) :: schema_list()

Gets a collection of schemas from the database but allows for a filter or an options list.

options

Options

  • :repo - A module that uses the Ecto.Repo Module.

examples

Examples

iex> Enum.each(1..4, fn _ -> create_user() end)
iex> length(EctoSchemas.Actions.all(EctoSchemas.Accounts.User, first: 3)) === 3
true

iex> Enum.each(1..4, fn _ -> create_user() end)
iex> length(EctoSchemas.Actions.all(EctoSchemas.Accounts.User, repo: MyApp.MyRepoModule.Repo)) === 3
true
Link to this function

all(query, params, opts)

View Source

Specs

all(queryable :: query(), params :: filter_params(), opts()) :: schema_list()

Similar to all/2 but can also accept a keyword options list.

options

Options

  • :repo - A module that uses the Ecto.Repo Module.

examples

Examples

iex> Enum.each(1..4, fn _ -> create_user() end) iex> length(EctoSchemas.Actions.all(EctoSchemas.Accounts.User, first: 3, repo: MyApp.MyRepoModule.Repo)) === 3 true

Link to this function

create(schema, params, opts \\ [])

View Source

Specs

create(schema :: Ecto.Schema.t(), params :: filter_params(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Creates a schema with given params. Can also accept a keyword options list.

options

Options

  • :repo - A module that uses the Ecto.Repo Module.

examples

Examples

iex> {:ok, schema} = EctoSchemas.Actions.create(EctoSchemas.Accounts.User, user_params(first_name: "TEST"))
iex> schema.first_name
"TEST"
iex> {:error, changeset} = EctoSchemas.Actions.create(EctoSchemas.Accounts.User, Map.delete(user_params(), :first_name))
iex> "can't be blank" in errors_on(changeset).first_name
true

examples-1

Examples

iex> {:ok, schema} = EctoSchemas.Actions.create(EctoSchemas.Accounts.User, user_params(first_name: "TEST"), repo: MyApp.MyRepoModule.Repo)
iex> schema.first_name
true

Specs

delete(schema_data :: Ecto.Schema.t()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Deletes a schema

examples

Examples

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.delete(user)
iex> schema.first_name === user.first_name
true
Link to this function

delete(schema_data, opts)

View Source

Specs

delete(schema_data :: Ecto.Schema.t(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
delete(schema :: Ecto.Schema.t(), id :: integer()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Similar to delete/1 but can also accept a keyword options list.

options

Options

  • :repo - A module that uses the Ecto.Repo Module.

examples

Examples

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.delete(user, repo: MyApp.MyRepoModule.Repo)
iex> schema.first_name === user.first_name
true
Link to this function

delete(schema, id, opts)

View Source

Specs

delete(schema :: Ecto.Schema.t(), id :: integer(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Deletes a schema. Can also accept a keyword options list.

options

Options

  • :repo - A module that uses the Ecto.Repo Module.

examples

Examples

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.delete(EctoSchemas.Accounts.User, user.id)
iex> schema.first_name === user.first_name
true

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.delete(EctoSchemas.Accounts.User, user.id)
iex> schema.first_name === user.first_name
true
Link to this function

find(query, params, opts \\ [])

View Source

Specs

find(queryable :: query(), params :: filter_params(), opts()) ::
  schema_res() | {:error, any()}

Finds a schema with matching params. Can also accept a keyword options list.

options

Options

  • :repo - A module that uses the Ecto.Repo Module.

examples

Examples

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.find(EctoSchemas.Accounts.User, first_name: user.first_name)
iex> schema.first_name === user.first_name
true

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.find(EctoSchemas.Accounts.User, first_name: user.first_name, repo: MyApp.MyRepoModule.Repo)
iex> schema.first_name === user.first_name
true
Link to this function

find_and_update(schema, params, update_params, opts \\ [])

View Source

Specs

find_and_update(Ecto.Schema.t(), map(), map(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Finds a schema by params and updates it or creates with results of params/update_params merged. Can also accept a keyword options list.

Note: Relational filtering doesn't work on this function

options

Options

  • :repo - A module that uses the Ecto.Repo Module.
  • :replica - If you don't want to perform any reads against your Primary, you can specify a replica to read from.

examples

Examples

iex> {:ok, schema} = EctoSchemas.Actions.find_and_update(EctoSchemas.Accounts.User, %{email: "some_email"}, %{name: "great name"})

iex> {:ok, schema} = EctoSchemas.Actions.find_and_update(EctoSchemas.Accounts.User, %{email: "some_email"}, %{name: "great name}, repo: MyApp.MyRepoModule.Repo, replica: MyApp.MyRepoModule.Repo.replica())
Link to this function

find_and_upsert(schema, params, update_params, opts \\ [])

View Source

Specs

find_and_upsert(Ecto.Schema.t(), map(), map(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Finds a schema by params and updates it or creates with results of params/update_params merged. Can also accept a keyword options list.

Note: Relational filtering doesn't work on this function

options

Options

  • :repo - A module that uses the Ecto.Repo Module.
  • :replica - If you don't want to perform any reads against your Primary, you can specify a replica to read from.

examples

Examples

iex> {:ok, schema} = EctoSchemas.Actions.find_and_upsert(EctoSchemas.Accounts.User, %{email: "some_email"}, %{name: "great name"})

iex> {:ok, schema} = EctoSchemas.Actions.find_and_upsert(EctoSchemas.Accounts.User, %{email: "some_email"}, %{name: "great name}, repo: MyApp.MyRepoModule.Repo, replica: MyApp.MyRepoModule.Repo.replica())
Link to this function

find_or_create(schema, params, opts \\ [])

View Source

Specs

find_or_create(Ecto.Schema.t(), map(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Finds a schema by params or creates one if it isn't found. Can also accept a keyword options list.

Note: Relational filtering doesn't work on this function

options

Options

  • :repo - A module that uses the Ecto.Repo Module.
  • :replica - If you don't want to perform any reads against your Primary, you can specify a replica to read from.

examples

Examples

iex> {:ok, schema} = EctoSchemas.Actions.find_or_create(EctoSchemas.Accounts.User, %{name: "great name"})

iex> {:ok, schema} = EctoSchemas.Actions.find_or_create(EctoSchemas.Accounts.User, %{name: "great name"}, repo: MyApp.MyRepoModule.Repo, replica: MyApp.MyRepoModule.Repo.replica())
Link to this function

find_or_create_many(schema, param_list, opts)

View Source

Specs

find_or_create_many(
  Ecto.Schema.t(),
  [map()],
  opts()
) :: {:ok, [Ecto.Schema.t()]} | {:error, [Ecto.Changeset.t()]}

Accepts a list of schemas and attempts to find them in the DB. Any missing Schemas will be created. Can also accept a keyword options list.

Note: Relational filtering doesn't work on this function

options

Options

  • :repo - A module that uses the Ecto.Repo Module.
  • :replica - If you don't want to perform any reads against your Primary, you can specify a replica to read from.

examples

Examples

iex> {:ok, records} = EctoSchemas.Actions.find_or_create_many(EctoSchemas.Accounts.User, [%{name: "foo"}, %{name: "bar}]) iex> length(records) === 2

Link to this function

get(schema, id, opts \\ [])

View Source

Specs

get(queryable :: query(), id :: term(), options :: Keyword.t()) ::
  Ecto.Schema.t() | nil

Gets a schema from the database

examples

Examples

iex> user = create_user()
iex> %{id: id} = EctoSchemas.Actions.get(EctoSchemas.Accounts.User, user.id)
iex> id === user.id
true
iex> EctoSchemas.Actions.get(EctoSchemas.Accounts.User, 2504390) # ID nonexistant
nil
Link to this function

stream(query, params, opts \\ [])

View Source

Specs

stream(queryable :: query(), params :: filter_params(), opts()) :: Enum.t()

Gets a collection of schemas from the database but allows for a filter

Link to this function

update(schema, schema_data, updates, opts \\ [])

View Source

Specs

update(schema(), id(), updates(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
update(schema(), schema_data(), updates(), opts()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Updates a schema with given updates. Can also accept a keyword options list.

options

Options

  • :repo - A module that uses the Ecto.Repo Module.
  • :replica - If you don't want to perform any reads against your Primary, you can specify a replica to read from.

examples

Examples

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.update(EctoSchemas.Accounts.User, user, first_name: user.first_name)
iex> schema.first_name === user.first_name
true

iex> user = create_user()
iex> {:ok, schema} = EctoSchemas.Actions.update(EctoSchemas.Accounts.User, 1, first_name: user.first_name, repo: MyApp.MyRepoModule.Repo, replica: MyApp.MyRepoModule.Repo.replica())
iex> schema.first_name === user.first_name
true