https://github.com/lpil/pgo

🐘 Use PostgreSQL databases with PGO
https://github.com/lpil/pgo

erlang gleam postgresql postgresql-client

Last synced: about 2 months ago
JSON representation

🐘 Use PostgreSQL databases with PGO

• Host: GitHub
• URL: https://github.com/lpil/pgo
• Owner: lpil
• License: apache-2.0
• Created: 2019-11-17T19:46:29.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T13:56:33.000Z (6 months ago)
• Last Synced: 2024-05-01T23:05:13.204Z (5 months ago)
• Topics: erlang, gleam, postgresql, postgresql-client
• Language: Gleam
• Homepage: https://hexdocs.pm/gleam_pgo/
• Size: 84 KB
• Stars: 76
• Watchers: 3
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-gleam - gleam_pgo - [📚](https://hexdocs.pm/gleam_pgo/) - Gleam bindings to the PGO PostgreSQL client (Packages / Databases)

README

        
# Gleam PGO

A PostgreSQL database client for Gleam, based on [PGO][erlang-pgo].

[erlang-pgo]: https://github.com/erleans/pgo

```gleam

import gleam/pgo

import gleam/dynamic

import gleeunit/should

pub fn main() {

  // Start a database connection pool.

  // Typically you will want to create one pool for use in your program

  let db = pgo.connect(pgo.Config(

    ..pgo.default_config(),

    host: "localhost",

    database: "my_database",

    pool_size: 15,

  ))

  // An SQL statement to run. It takes one int as a parameter

  let sql = "

  select

    name, age, colour, friends

  from

    cats

  where

    id = $1"

  // This is the decoder for the value returned by the query

  let return_type = dynamic.tuple4(

    dynamic.string,

    dynamic.int,

    dynamic.string,

    dynamic.list(dynamic.string),

  )

  // Run the query against the PostgreSQL database

  // The int `1` is given as a parameter

  let assert Ok(response) = 

    pgo.execute(sql, db, [pgo.int(1)], return_type)

  // And then do something with the returned results

  response.count

  |> should.equal(2)

  response.rows

  |> should.equal([

    #("Nubi", 3, "black", ["Al", "Cutlass"]),

  ])

}

```

## Installation

```sh

gleam add gleam_pgo

```

## Atom generation

Creating a connection pool with the `pgo.connect` function dynamically generates

an Erlang atom. Atoms are not garbage collected and only a certain number of

them can exist in an Erlang VM instance, and hitting this limit will result in

the VM crashing. Due to this limitation you should not dynamically open new

connection pools, instead create the pools you need when your application starts

and reuse them throughout the lifetime of your program.