Module eysql_config

Options, their defaults, and validation.

Description

Options, their defaults, and validation.

The load-balancing options keep the YugabyteDB smart drivers' names and units (seconds), so anyone who has configured one of those recognises them. Every other duration is in milliseconds.

An option with a counterpart in the JDBC smart driver has that driver's default: load_balance is off, connect_timeout is pgjdbc's 10 s, and database is named after the user. username and application_name name who connects, so they keep eysql's own values.

Data Types

config()

config() = #{atom() => term()}

options()

options() = #{atom() => term()}

Function Index

defaults/0The default for every option.
normalize/1Merge options over the defaults, validate them and derive the internal settings.

Function Details

defaults/0

defaults() -> options()

The default for every option.

normalize/1

normalize(Options::options()) -> {ok, config()} | {error, term()}

Merge options over the defaults, validate them and derive the internal settings.


Generated by EDoc