# Database

A BEAM-native database that leverages on the power of DETS

[![Package Version](https://img.shields.io/hexpm/v/database)](https://hex.pm/packages/database)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/database/)

```sh
gleam add database
```
```gleam
import database
import gleam/option
import gleam/dynamic/decode

type Music {
  // The first value of the custom type will always
  // be its primary_key, so if you want a specific value,
  // make sure to make it the first value.
  Music(name: String, release_year: Int)
}

fn music_decoder() {
  use name <- database.field(0, decode.string)
  use release_year <- database.field(1, decode.int)
  decode.success(Music(name: release_year))
}

const music_table_def = Music(name: "Music name", year: 0000)

pub fn main() -> Nil {
  let assert Ok(table) = database.create_table(
    definition: music_table_def, 
    decode_with: music_decoder())

  // All interactions with the table happen within a transaction
  let assert Ok(Nil) = database.transaction(table, fn(ref) {
    database.insert(ref, Music("The Rains of Castemere", 2019))
  })

  // You can do multiple operations within the same transaction, as long as they don't interact with each other
  let _ = database.transaction(table, fn(ref) {
    let assert Ok(Nil) = database.insert(ref, Music("Templars", 2025))
    let assert Ok(Nil) = database.insert(ref, Music("Kids", 2009))
    let assert Ok(Nil) = database.delete(ref, "The Rains of Castemere")
  })

  // You can find elements by their primary_key...
  let _ = database.transaction(table, fn(ref) {
    let assert option.None = database.find(ref, "The Rains of Castemere")
    let assert option.Some(Music("Templars", 2025)) = database.find(ref, "Templars")
  })

  // [...] or by complex queries
  let assert Ok([_, _]) = database.transaction(table, fn(ref) {
    database.select(ref, fn(value) {
      case value {
        Music(_, year) if year > 2000 -> database.Continue(value)
        _ -> database.Skip
      }
    })
  })
}
```

Further documentation can be found at <https://hexdocs.pm/database>.

## Development

```sh
gleam run   # Run the project
gleam test  # Run the tests
```