dream_ets/config

Types

Access

pub type Access {
  Public
  Protected
  Private
}

Constructors

```
Public
```
```
Protected
```
```
Private
```

TableConfig

opaque </>

pub opaque type TableConfig(key, value)

TableType

</>

pub type TableType {
  Set
  OrderedSet
  Bag
  DuplicateBag
}

Constructors

```
Set
```
```
OrderedSet
```
```
Bag
```
```
DuplicateBag
```

Values

access

</>

pub fn access(
  config: TableConfig(k, v),
  access_mode: Access,
) -> TableConfig(k, v)

Set the access mode

access_private

</>

pub fn access_private() -> Access

access_protected

</>

pub fn access_protected() -> Access

access_public

</>

pub fn access_public() -> Access

Helper functions to create Access values

compressed

</>

pub fn compressed(
  config: TableConfig(k, v),
  enabled: Bool,
) -> TableConfig(k, v)

Enable or disable table compression

counter

</>

pub fn counter(
  config: TableConfig(String, Int),
) -> TableConfig(String, Int)

Convenience: Configure as counter table (String keys, Int values)

create

</>

pub fn create(
  config: TableConfig(k, v),
) -> Result(table.Table(k, v), table.EtsError)

Create the table from configuration

Validates configuration and creates the ETS table. Returns an error if the table name already exists or configuration is invalid.

key

</>

pub fn key(
  config: TableConfig(k, v),
  encoder: fn(k) -> dynamic.Dynamic,
  decoder: decode.Decoder(k),
) -> TableConfig(k, v)

Set key encoder and decoder

key_string

</>

pub fn key_string(
  config: TableConfig(String, v),
) -> TableConfig(String, v)

Convenience: Set string key encoding

keypos

</>

pub fn keypos(
  config: TableConfig(k, v),
  pos: Int,
) -> TableConfig(k, v)

Set the key position in tuples (default: 1)

new

</>

pub fn new(name: String) -> TableConfig(k, v)

Create a new table configuration with sensible defaults

Defaults:

Table type: Set
Access: Public
Key position: 1
Read concurrency: True
Write concurrency: False
Compressed: False
Named table: True

Example

import dream_ets as ets

let config = ets.new("my_table")

read_concurrency

</>

pub fn read_concurrency(
  config: TableConfig(k, v),
  enabled: Bool,
) -> TableConfig(k, v)

Enable or disable read concurrency

table_type

</>

pub fn table_type(
  config: TableConfig(k, v),
  type_: TableType,
) -> TableConfig(k, v)

Set the table type

table_type_bag

</>

pub fn table_type_bag() -> TableType

table_type_duplicate_bag

</>

pub fn table_type_duplicate_bag() -> TableType

table_type_ordered_set

</>

pub fn table_type_ordered_set() -> TableType

table_type_set

</>

pub fn table_type_set() -> TableType

Helper functions to create TableType values

value

</>

pub fn value(
  config: TableConfig(k, v),
  encoder: fn(v) -> dynamic.Dynamic,
  decoder: decode.Decoder(v),
) -> TableConfig(k, v)

Set value encoder and decoder

value_string

</>

pub fn value_string(
  config: TableConfig(k, String),
) -> TableConfig(k, String)

Convenience: Set string value encoding

write_concurrency

</>

pub fn write_concurrency(
  config: TableConfig(k, v),
  enabled: Bool,
) -> TableConfig(k, v)

Enable or disable write concurrency