View Source DBCluster.ClusterMemberLib (DB Cluster v0.0.2)
Library of cluster_member related functions.
Summary
Functions
Returns an %Ecto.Changeset{}
for tracking cluster_member changes.
Creates a cluster_member.
Deletes a cluster_member.
Gets a single cluster_member.
Gets a single cluster_member.
Returns the list of cluster_members.
Updates a cluster_member.
Functions
@spec change_cluster_member(DBCluster.ClusterMember.t(), map()) :: Ecto.Changeset.t()
Returns an %Ecto.Changeset{}
for tracking cluster_member changes.
Examples
iex> change_cluster_member(cluster_member)
%Ecto.Changeset{data: %ClusterMember{}}
@spec create_cluster_member(map()) :: {:ok, DBCluster.ClusterMember.t()} | {:error, Ecto.Changeset.t()}
Creates a cluster_member.
Examples
iex> create_cluster_member(%{field: value})
{:ok, %ClusterMember{}}
iex> create_cluster_member(%{field: bad_value})
{:error, %Ecto.Changeset{}}
@spec delete_cluster_member(DBCluster.ClusterMember.t()) :: {:ok, DBCluster.ClusterMember.t()} | {:error, Ecto.Changeset.t()}
Deletes a cluster_member.
Examples
iex> delete_cluster_member(cluster_member)
{:ok, %ClusterMember{}}
iex> delete_cluster_member(cluster_member)
{:error, %Ecto.Changeset{}}
@spec get_cluster_member(DBCluster.ClusterMember.id(), list()) :: DBCluster.ClusterMember.t() | nil
Gets a single cluster_member.
Returns nil if the ClusterMember does not exist.
Examples
iex> get_cluster_member(123)
%ClusterMember{}
iex> get_cluster_member(456)
nil
@spec get_cluster_member!(DBCluster.ClusterMember.id(), list()) :: DBCluster.ClusterMember.t()
Gets a single cluster_member.
Raises Ecto.NoResultsError
if the ClusterMember does not exist.
Examples
iex> get_cluster_member!(123)
%ClusterMember{}
iex> get_cluster_member!(456)
** (Ecto.NoResultsError)
@spec list_cluster_members(list()) :: [DBCluster.ClusterMember.t()]
Returns the list of cluster_members.
Examples
iex> list_cluster_members()
[%ClusterMember{}, ...]
@spec update_cluster_member(DBCluster.ClusterMember.t(), map()) :: {:ok, DBCluster.ClusterMember.t()} | {:error, Ecto.Changeset.t()}
Updates a cluster_member.
Examples
iex> update_cluster_member(cluster_member, %{field: new_value})
{:ok, %ClusterMember{}}
iex> update_cluster_member(cluster_member, %{field: bad_value})
{:error, %Ecto.Changeset{}}