DeltaQuery.Config (DeltaQuery v0.2.3)

Copy Markdown View Source

Runtime configuration for Delta Query client.

Configuration can be set via:

  1. Application environment (config.exs):

    config :delta_query, :config, endpoint: "https://...", bearer_token: "...", share: "my_share", schema: "public"

  2. Per-query options passed to DeltaQuery.Query.execute/2

Required Keys

  • :endpoint - Delta Sharing server URL
  • :bearer_token - Authentication token
  • :share - Share name to query

Optional Keys

  • :schema - Schema name (default: "public")
  • :req_options - Options passed to Req requests (default: [])

Summary

Types

t()

Functions

new(opts \\ [])

Build a config struct from keyword options, falling back to application env.

new!(opts \\ [])

Build a config struct, raising on error.

Types

t()

@type t() :: %DeltaQuery.Config{
  bearer_token: String.t(),
  endpoint: String.t(),
  req_options: keyword(),
  schema: String.t(),
  share: String.t()
}

Functions

new(opts \\ [])

@spec new(keyword()) :: {:ok, t()} | {:error, String.t()}

Build a config struct from keyword options, falling back to application env.

new!(opts \\ [])

@spec new!(keyword()) :: t()

Build a config struct, raising on error.