EctoFoundationDB.Indexer behaviour (Ecto.Adapters.FoundationDB v0.7.7)

Copy Markdown View Source

Implement this behaviour to create a custom index.

Each Indexer has access to read, write, and clear any and all data in the database. A faulty implementation may lead to data loss or corruption.

Summary

Types

schema()

The schema module an index is defined on -- the module itself, not a struct built from it. Implementations call c:Ecto.Schema.__schema__/1 on it to reach field names and types.

Callbacks

clear(t, transaction, t, schema, tuple)
create(t, transaction, t, schema, tuple, integer)
create_range(t, t)
drop_ranges(t, t)
range(t, t, t)
set(t, transaction, t, schema, tuple)
unpack(t, t, tuple)
update(t, transaction, t, schema, tuple, t)

Functions

clear(tenant, tx, metadata, schema, kv)
create(tenant, tx, idx, schema, range, limit)
create_range(tenant, idx)
drop_ranges(tenant, idx)
range(idx, plan, options)
set(tenant, tx, metadata, schema, kv)
unpack(idx, plan, fdb_kv)
update(tenant, tx, metadata, schema, kv, updates)

Types

schema()

@type schema() :: module()

The schema module an index is defined on -- the module itself, not a struct built from it. Implementations call c:Ecto.Schema.__schema__/1 on it to reach field names and types.

Callbacks

clear(t, transaction, t, schema, tuple)

@callback clear(
  EctoFoundationDB.Tenant.t(),
  :erlfdb.transaction(),
  EctoFoundationDB.Index.t(),
  schema(),
  tuple()
) :: :ok

create(t, transaction, t, schema, tuple, integer)

@callback create(
  EctoFoundationDB.Tenant.t(),
  :erlfdb.transaction(),
  EctoFoundationDB.Index.t(),
  schema(),
  tuple(),
  integer()
) :: {integer(), {:erlfdb.key(), :erlfdb.key()}}

create_range(t, t)

@callback create_range(EctoFoundationDB.Tenant.t(), EctoFoundationDB.Index.t()) ::
  {:erlfdb.key(), :erlfdb.key()}

drop_ranges(t, t)

@callback drop_ranges(EctoFoundationDB.Tenant.t(), EctoFoundationDB.Index.t()) ::
  [:erlfdb.key()] | [{:erlfdb.key(), :erlfdb.key()}]

range(t, t, t)

@callback range(EctoFoundationDB.Index.t(), EctoFoundationDB.QueryPlan.t(), Keyword.t()) ::
  tuple()

set(t, transaction, t, schema, tuple)

@callback set(
  EctoFoundationDB.Tenant.t(),
  :erlfdb.transaction(),
  EctoFoundationDB.Index.t(),
  schema(),
  tuple()
) :: :ok

unpack(t, t, tuple)

(optional) 
@callback unpack(EctoFoundationDB.Index.t(), EctoFoundationDB.QueryPlan.t(), tuple()) ::
  tuple()

update(t, transaction, t, schema, tuple, t)

(optional) 
@callback update(
  EctoFoundationDB.Tenant.t(),
  :erlfdb.transaction(),
  EctoFoundationDB.Index.t(),
  schema(),
  tuple(),
  Keyword.t()
) :: :ok

Functions

clear(tenant, tx, metadata, schema, kv)

create(tenant, tx, idx, schema, range, limit)

create_range(tenant, idx)

drop_ranges(tenant, idx)

range(idx, plan, options)

set(tenant, tx, metadata, schema, kv)

unpack(idx, plan, fdb_kv)

update(tenant, tx, metadata, schema, kv, updates)