WeaviateEx.Collection (WeaviateEx v0.7.4)

Collection handle with default tenant and consistency settings.

Use this when you want to reuse tenant/consistency defaults across data operations.

Examples

collection =
  WeaviateEx.Collection.new(client, "Article",
    tenant: "tenant-a",
    consistency_level: "QUORUM"
  )

{:ok, _} = WeaviateEx.Collection.insert(collection, %{properties: %{title: "Hello"}})

Summary

Types

t()

Functions

delete(collection, id, opts \\ [])

exists?(collection, id, opts \\ [])

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

insert(collection, data, opts \\ [])

new(client, name, opts \\ [])

patch(collection, id, data, opts \\ [])

replace(collection, id, data, opts \\ [])

update(collection, id, data, opts \\ [])

validate(collection, data, opts \\ [])

with_consistency(collection, consistency_level)

with_tenant(collection, tenant)

Types

t()

@type t() :: %WeaviateEx.Collection{
  client: WeaviateEx.Client.t(),
  consistency_level: String.t() | atom() | nil,
  name: String.t(),
  tenant: String.t() | nil
}

Functions

delete(collection, id, opts \\ [])

@spec delete(t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, WeaviateEx.Error.t()}

exists?(collection, id, opts \\ [])

@spec exists?(t(), String.t(), keyword()) ::
  {:ok, boolean()} | {:error, WeaviateEx.Error.t()}

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

@spec get(t(), String.t(), keyword()) :: {:ok, map()} | {:error, WeaviateEx.Error.t()}

insert(collection, data, opts \\ [])

@spec insert(t(), map(), keyword()) :: {:ok, map()} | {:error, WeaviateEx.Error.t()}

new(client, name, opts \\ [])

@spec new(WeaviateEx.Client.t(), String.t(), keyword()) :: t()

patch(collection, id, data, opts \\ [])

@spec patch(t(), String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, WeaviateEx.Error.t()}

replace(collection, id, data, opts \\ [])

@spec replace(t(), String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, WeaviateEx.Error.t()}

update(collection, id, data, opts \\ [])

@spec update(t(), String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, WeaviateEx.Error.t()}

validate(collection, data, opts \\ [])

@spec validate(t(), map(), keyword()) :: {:ok, map()} | {:error, WeaviateEx.Error.t()}

with_consistency(collection, consistency_level)

@spec with_consistency(t(), String.t() | atom() | nil) :: t()

with_tenant(collection, tenant)

@spec with_tenant(t(), String.t() | nil) :: t()