@spec create_index(
  LadybugEx.Connection.t(),
  String.t(),
  atom() | String.t() | [atom() | String.t()]
) ::
  {:ok, :created} | {:error, String.t()}

Creates an index on specified columns of a table.

Parameters

• conn - A connection reference
• table_name - The name of the table
• columns - Column or list of columns to index

Examples

iex> LadybugEx.Schema.create_index(conn, "Person", :email)
{:ok, :created}

iex> LadybugEx.Schema.create_index(conn, "Person", [:age, :city])
{:ok, :created}

@spec create_index!(
  LadybugEx.Connection.t(),
  String.t(),
  atom() | String.t() | [atom() | String.t()]
) ::
  :created

Creates an index on specified columns, raising on error.

Same as create_index/3 but raises an exception on error.

@spec create_node_table(
  LadybugEx.Connection.t(),
  String.t(),
  [property_def()],
  keyword()
) ::
  {:ok, :created} | {:error, String.t()}

Creates a node table with the specified properties.

Parameters

• conn - A connection reference
• table_name - The name of the node table to create
• properties - A list of property definitions
• opts - Table creation options

Property Definition

Properties can be defined as:

• {name, type} - Simple property definition
• {name, type, opts} - Property with options like primary key

Options

• :primary_key - Specify the primary key column(s)

Examples

iex> LadybugEx.Schema.create_node_table(conn, "Person", [
...>   {:name, :string},
...>   {:age, :int64},
...>   {:email, :string}
...> ], primary_key: [:name])
{:ok, :created}

iex> LadybugEx.Schema.create_node_table(conn, "Product", [
...>   {:id, :int64, primary_key: true},
...>   {:name, :string},
...>   {:price, :double},
...>   {:tags, {:list, :string}}
...> ])
{:ok, :created}

@spec create_node_table!(
  LadybugEx.Connection.t(),
  String.t(),
  [property_def()],
  keyword()
) :: :created

Creates a node table, raising on error.

Same as create_node_table/4 but raises an exception on error.

@spec create_rel_table(
  LadybugEx.Connection.t(),
  String.t(),
  String.t(),
  String.t(),
  [property_def()],
  keyword()
) :: {:ok, :created} | {:error, String.t()}

Creates a relationship table with the specified properties.

Parameters

• conn - A connection reference
• table_name - The name of the relationship table to create
• from_table - The source node table
• to_table - The destination node table
• properties - A list of property definitions
• opts - Table creation options

Options

• :multiplicity - Can be :one_to_one, :one_to_many, :many_to_many (default)

Examples

iex> LadybugEx.Schema.create_rel_table(conn, "KNOWS",
...>   "Person", "Person",
...>   [
...>     {:since, :date},
...>     {:strength, :double}
...>   ]
...> )
{:ok, :created}

iex> LadybugEx.Schema.create_rel_table(conn, "OWNS",
...>   "Person", "Product",
...>   [
...>     {:quantity, :int64},
...>     {:purchase_date, :date}
...>   ],
...>   multiplicity: :one_to_many
...> )
{:ok, :created}

@spec create_rel_table!(
  LadybugEx.Connection.t(),
  String.t(),
  String.t(),
  String.t(),
  [property_def()],
  keyword()
) :: :created

Creates a relationship table, raising on error.

Same as create_rel_table/6 but raises an exception on error.

@spec describe_table(LadybugEx.Connection.t(), String.t()) ::
  {:ok, map()} | {:error, String.t()}

Gets information about a table's schema.

Parameters

• conn - A connection reference
• table_name - The name of the table

Examples

iex> LadybugEx.Schema.describe_table(conn, "Person")
{:ok, %{
  name: "Person",
  type: "NODE",
  columns: [
    %{name: "name", type: "STRING", is_primary: true},
    %{name: "age", type: "INT64", is_primary: false}
  ]
}}

@spec drop_node_table(LadybugEx.Connection.t(), String.t(), keyword()) ::
  {:ok, :dropped} | {:error, String.t()}

Drops a node table.

Parameters

• conn - A connection reference
• table_name - The name of the table to drop
• opts - Drop options

Options

• :cascade - Not currently supported by LadybugDB (ignored)

Examples

iex> LadybugEx.Schema.drop_node_table(conn, "Person")
{:ok, :dropped}

iex> LadybugEx.Schema.drop_node_table(conn, "Person", cascade: true)
{:ok, :dropped}

@spec drop_node_table!(LadybugEx.Connection.t(), String.t(), keyword()) :: :dropped

Drops a node table, raising on error.

Same as drop_node_table/3 but raises an exception on error.

@spec drop_rel_table(LadybugEx.Connection.t(), String.t(), keyword()) ::
  {:ok, :dropped} | {:error, String.t()}

Drops a relationship table.

Parameters

• conn - A connection reference
• table_name - The name of the relationship table to drop
• opts - Drop options

Examples

iex> LadybugEx.Schema.drop_rel_table(conn, "KNOWS")
{:ok, :dropped}

@spec drop_rel_table!(LadybugEx.Connection.t(), String.t(), keyword()) :: :dropped

Drops a relationship table, raising on error.

Same as drop_rel_table/3 but raises an exception on error.

@spec list_node_tables(LadybugEx.Connection.t()) ::
  {:ok, [String.t()]} | {:error, String.t()}

Lists all node tables in the database.

Parameters

• conn - A connection reference

Examples

iex> LadybugEx.Schema.list_node_tables(conn)
{:ok, ["Person", "Product", "Order"]}

@spec list_rel_tables(LadybugEx.Connection.t()) ::
  {:ok, [String.t()]} | {:error, String.t()}

Lists all relationship tables in the database.

Parameters

• conn - A connection reference

Examples

iex> LadybugEx.Schema.list_rel_tables(conn)
{:ok, ["KNOWS", "OWNS", "PURCHASED"]}