AshScylla (AshScylla v0.7.0)

Copy Markdown View Source

AshScylla is a data layer for Ash Framework that uses ScyllaDB (via Xandra).

Usage

Configure your Ash resource to use AshScylla.DataLayer:

defmodule MyApp.MyResource do
  use Ash.Resource,
    data_layer: AshScylla.DataLayer

  attributes do
    uuid_primary_key :id
    attribute :name, :string
    attribute :email, :string
  end
end

Configure your repo to use AshScylla:

defmodule MyApp.Repo do
  use AshScylla.Repo,
    otp_app: :my_app
end

Then configure your resource to use the repo:

# In your resource configuration
use Ash.Resource,
  data_layer: AshScylla.DataLayer,
  repo: MyApp.Repo

Summary

Functions

create_keyspace(repo)

Creates the keyspace for a repo if it doesn't exist.

migrate(repo, opts \\ [])

Runs migrations for all AshScylla resources against the given repo.

version()

Returns the version of AshScylla.

Functions

create_keyspace(repo)

@spec create_keyspace(module()) :: :ok | {:error, term()}

Creates the keyspace for a repo if it doesn't exist.

Examples

AshScylla.create_keyspace(MyApp.Repo)

migrate(repo, opts \\ [])

@spec migrate(
  module(),
  keyword()
) :: :ok | {:error, term()}

Runs migrations for all AshScylla resources against the given repo.

This is a convenience function for use in release tasks or scripts.

Options

  • :resources - List of specific resource modules to migrate (default: auto-discover)
  • :dry_run - If true, only log statements without executing
  • :create_keyspace - Create the keyspace before migrating

Examples

AshScylla.migrate(MyApp.Repo)

AshScylla.migrate(MyApp.Repo, resources: [MyApp.User])

AshScylla.migrate(MyApp.Repo, dry_run: true)

version()

@spec version() :: String.t()

Returns the version of AshScylla.