Squirrelix.ConnectionOptions (Squirrelix v0.4.0)

Copy Markdown View Source

PostgreSQL connection settings for Squirrelix.

Squirrelix uses a plain Elixir struct — not a Gleam-style opaque record. Fields are regular struct keys you can pattern match on or convert to a Postgrex/DBConnection keyword list when needed.

SSL

The :ssl field is passed through to Postgrex as the :ssl start option:

  • false — no TLS (default)
  • true — TLS with Postgrex secure defaults (peer + hostname verification)
  • keyword list — TLS with custom :ssl options (for example [verify: :verify_none] for sslmode=require)
  • nil — unset (used when a URL omits SSL params so env/PGSSLMODE can apply)

Summary

Types

ssl()
t()

Types

ssl()

@type ssl() :: boolean() | keyword() | nil

t()

@type t() :: %Squirrelix.ConnectionOptions{
  database: String.t(),
  host: String.t(),
  password: String.t(),
  port: pos_integer(),
  ssl: ssl(),
  timeout_seconds: non_neg_integer(),
  user: String.t()
}