feather

Types

Config

pub type Config {
  Config(
    file: String,
    journal_mode: JournalMode,
    synchronous: SyncMode,
    temp_store: TempStore,
    mmap_size: Option(Int),
    page_size: Option(Int),
  )
}

Constructors

Config(
  file: String,
  journal_mode: JournalMode,
  synchronous: SyncMode,
  temp_store: TempStore,
  mmap_size: Option(Int),
  page_size: Option(Int),
)

JournalMode

</>

pub type JournalMode {
  JournalDelete
  JournalTruncate
  JournalPersist
  JournalMemory
  JournalWal
  JournalOff
}

Constructors

```
JournalDelete
```
```
JournalTruncate
```
```
JournalPersist
```
```
JournalMemory
```
```
JournalWal
```
```
JournalOff
```

SyncMode

</>

pub type SyncMode {
  SyncExtra
  SyncFull
  SyncNormal
  SyncOff
}

Constructors

```
SyncExtra
```
```
SyncFull
```
```
SyncNormal
```
```
SyncOff
```

TempStore

</>

pub type TempStore {
  TempStoreDefault
  TempStoreFile
  TempStoreMemory
}

Constructors

```
TempStoreDefault
```
```
TempStoreFile
```
```
TempStoreMemory
```

Functions

connect

</>

pub fn connect(config: Config) -> Result(Connection, Error)

default_config

</>

pub fn default_config() -> Config

disconnect

</>

pub fn disconnect(connection: Connection) -> Result(Nil, Error)

runs “PRAGMA optimize;” before closing the connection. If the connections are long-lived, then consider running this periodically anyways.

main

</>

pub fn main() -> Nil

Runs the feather cli to generate new migrations and dump the schema you probably don’t wanna run this yourself… run gleam run -m feather to find out more

optimize

</>

pub fn optimize(connection: Connection) -> Result(Nil, Error)