Packages

cake

0.6.0
4.1.0 4.0.0 3.0.0 2.2.2 2.2.1 2.2.0 2.1.3 2.1.2 2.1.1 2.1.0 2.0.2 2.0.1 2.0.0 1.1.2 1.1.1 1.1.0 1.0.1 1.0.0 1.0.0-rc.0 retired 0.15.0 retired 0.14.0 retired 0.13.0 retired 0.12.0 retired 0.11.0 retired 0.10.1 retired 0.10.0 retired 0.9.2 retired 0.9.1 retired 0.9.0 retired 0.8.0 retired 0.7.0 retired 0.6.0 retired 0.5.0 retired 0.4.0 retired 0.3.0 retired 0.2.0 retired 0.1.0 retired 0.0.1 retired

🎂 An SQL query builder for Gleam for SQL dialects 🐘PostgreSQL, 🪶SQLite, 🦭MariaDB, and 🐬MySQL

Retired package: Deprecated - a stable release is available, please use >= 1.0.0
HexDocs

Current section

Files

Jump to
Readme
38 Versions
1 Dependency
Dependants
Files
Activity
cake README.md
Raw

README.md 

# Cake SQL Query Builder for Gleam



Cake is a library written in Gleam to compose SQL queries targeting SQL dialects PostgreSQL, SQLite, MariaDB and MySQL.



[![Package

<a href="https://github.com/inoas/gleam-cake/releases"><img src="https://img.shields.io/github/release/inoas/gleam-cake" alt="GitHub release"></a>

<a href="https://discord.gg/Fm8Pwmy"><img src="https://img.shields.io/discord/768594524158427167?color=blue" alt="Discord chat"></a>

![CI](https://github.com/inoas/gleam-cake/workflows/test/badge.svg?branch=main)

Version](https://img.shields.io/hexpm/v/cake)](https://hex.pm/packages/cake)

[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/cake/)

![Erlang-compatible](https://img.shields.io/badge/target-erlang-b83998)

![JavaScript Compatible](https://img.shields.io/badge/target-javascript-f3e155)

![Unit tests](https://github.com/github/docs/actions/workflows/test.yml/badge.svg)



## Installation



```shell

gleam add cake

```



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



## Examples



See Cake's [tests](https://github.com/inoas/gleam-cake/tree/main/test/cake_test).



## Tested targets



- Sqlite3 of [ubuntu:latest (Docker)](https://hub.docker.com/_/ubuntu)

- [postgres:latest (Docker)](https://hub.docker.com/_/postgres)

- [mariadb:latest (Docker)](https://hub.docker.com/_/mariadb)

- [mysql:latest (Docker)](https://hub.docker.com/_/mysql)



The tests run on Erlang but are generally target agnostic:

While the primary use case is to run queries on servers, this library runs on any Gleam target and for example in conjunction with [sqlite3 WASM/JS](https://sqlite.org/wasm) you may run queries composed with this library in browsers.



## Development



### Run test suite locally



```shell

bin/docker/attached

# wait a few seconds until everything is ready

# if you run gleam test too early, it will crash

gleam test

# or instead of gleam test, run:

# gleam test -- --glacier

# ...for incremental testing

```



### Helper commands



```shell

bin/docker/attached

bin/docker/detached

bin/docker/down



bin/test

bin/glacier



bin/birdie/interactive-review

bin/birdie/accept-all

bin/birdie/reject-all

```



## Library naming



The best part of working with CakePHP 3+ used to be its Query Builder. This library is inspired by that and thus the name.



Thank you [@lorenzo](https://github.com/lorenzo) and [@markstory](https://github.com/markstory) for creating and maintaining CakePHP and its awesome query builder over the years.