pg_value - v3.0.0

pg_value

PostgreSQL values, along with their encoders and decoders. Can be used by PostgreSQL client libraries written in gleam. Currently used by pgl.

Types

Value

</>

The Value type represents PostgreSQL data types. Values can be encoded to PostgreSQL’s binary format. Values can be used when interacting with PostgreSQL databases through client libraries like pgl.

pub type Value {
  Null
  Bool(Bool)
  Int(Int)
  Float(Float)
  Text(String)
  Bytea(BitArray)
  Time(calendar.TimeOfDay)
  Date(calendar.Date)
  Timestamp(timestamp.Timestamp)
  Timestamptz(timestamp.Timestamp, duration.Duration)
  Interval(interval.Interval)
  Array(List(Value))
  Uuid(BitArray)
  Hstore(dict.Dict(String, option.Option(String)))
  Enum(String)
  Json(json.Json)
}

Constructors

Values

array

</> 
pub fn array(elements: List(a), of kind: fn(a) -> Value) -> Value

Returns an Array value. Each element is converted using the provided function.

bool

</> 
pub fn bool(bool: Bool) -> Value

Returns a Bool value.

bytea

</> 
pub fn bytea(bytea: BitArray) -> Value

Returns a Bytea value.

date

</> 
pub fn date(date: calendar.Date) -> Value

Returns a Date value.

date_decoder

</> 
pub fn date_decoder() -> decode.Decoder(calendar.Date)

Returns a decoder for Date values.

decode

</> 
pub fn decode(
  bits: BitArray,
  info: type_info.TypeInfo,
) -> Result(dynamic.Dynamic, String)

Decodes binary PostgreSQL data into a Dynamic value. Dynamic values can then be decoded using gleam/dynamic/decode.

encode

</> 
pub fn encode(
  value: Value,
  info: type_info.TypeInfo,
) -> Result(BitArray, String)

Encodes a Value as a PostgreSQL data type

enum

</> 
pub fn enum(label: String) -> Value

Returns an Enum value with the given label.

false

</> 
pub const false: Value

float

</> 
pub fn float(float: Float) -> Value

Returns a Float value.

hstore

</> 
pub fn hstore(
  hstore: dict.Dict(String, option.Option(String)),
) -> Value

Returns an Hstore value. Keys map to optional string values.

int

</> 
pub fn int(int: Int) -> Value

Returns an Int value.

interval

</> 
pub fn interval(interval: interval.Interval) -> Value

Returns an Interval value.

json

</> 
pub fn json(json: json.Json) -> Value

Returns a Json value.

null

</> 
pub const null: Value

nullable

</> 
pub fn nullable(
  inner_type: fn(a) -> Value,
  optional: option.Option(a),
) -> Value

Checks if the provided value is option.Some or option.None. If None then the value returned is value.Null. If Some value is provided then it is passed to the inner_type function.

Example:

  let int = pg_value.nullable(pg_value.int, Some(10))

  let null = pg_value.nullable(pg_value.int, None)

text

</> 
pub fn text(text: String) -> Value

Returns a Text value.

time

</> 
pub fn time(time_of_day: calendar.TimeOfDay) -> Value

Returns a Time value.

time_decoder

</> 
pub fn time_decoder() -> decode.Decoder(calendar.TimeOfDay)

Returns a decoder for TimeOfDay values.

timestamp

</> 
pub fn timestamp(timestamp: timestamp.Timestamp) -> Value

Returns a Timestamp value.

timestamp_decoder

</> 
pub fn timestamp_decoder() -> decode.Decoder(timestamp.Timestamp)

Returns a decoder for Timestamp values.

timestamptz

</> 
pub fn timestamptz(
  timestamp: timestamp.Timestamp,
  offset: duration.Duration,
) -> Value

Returns a Timestamp value with a timezone offset.

to_string

</> 
pub fn to_string(value: Value) -> String

Converts a Value to a string formatted properly for PostgreSQL

true

</> 
pub const true: Value

uuid

</> 
pub fn uuid(uuid: BitArray) -> Value

Returns a UUID Value. Callers are responsible for ensuring the provided value is a valid UUID. If the value is not a valid UUID, encoding will fail.

✨ Search Document