Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tamizhvendan/honeyeql
HoneyEQL is a Clojure library enables you to query database using the EDN Query Language.
https://github.com/tamizhvendan/honeyeql
clojure edn eql honeysql mysql postgresql
Last synced: about 20 hours ago
JSON representation
HoneyEQL is a Clojure library enables you to query database using the EDN Query Language.
- Host: GitHub
- URL: https://github.com/tamizhvendan/honeyeql
- Owner: tamizhvendan
- License: epl-2.0
- Created: 2020-01-15T08:55:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T12:59:33.000Z (about 2 months ago)
- Last Synced: 2024-12-15T13:04:24.633Z (8 days ago)
- Topics: clojure, edn, eql, honeysql, mysql, postgresql
- Language: Clojure
- Homepage: https://cljdoc.org/d/com.github.tamizhvendan/honeyeql/CURRENT
- Size: 1.05 MB
- Stars: 206
- Watchers: 11
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## HoneyEQL
HoneyEQL is a Clojure library that enables you to query the database declaratively using the [EDN Query Language](https://edn-query-language.org)(EQL). It aims to simplify the effort required to work with relational databases in Clojure. It also provides database modification operations support using Clojure maps with namespace qualified keys.
[](https://clojars.org/com.github.tamizhvendan/honeyeql)
> Supports Postgres (9.4 & above) and MySQL (8.0 & above)
## Rationale
When a query involves more than one table, the declarative nature of SQL depreciates. Depending on the type of relationship, we have to put appropriate join conditions.
Let's assume that we have the following schema.
To get all the films of an actor with the id `148` along with his/her first name & last name, we have to query it as
```clojure
(jdbc/execute! ds ["SELECT actor.first_name, actor.last_name, film.title
FROM actor
LEFT OUTER JOIN film_actor ON film_actor.actor_id = actor.actor_id
LEFT OUTER JOIN film ON film_actor.film_id = film.film_id
WHERE actor.actor_id = ?" 148])
```
The query result would look like
```clojure
[{:actor/first_name "EMILY", :actor/last_name "DEE", :film/title "ANONYMOUS HUMAN"}
{:actor/first_name "EMILY", :actor/last_name "DEE", :film/title "BASIC EASY"}
{:actor/first_name "EMILY", :actor/last_name "DEE", :film/title "CHAMBER ITALIAN"}
...]
```
Then we need to do the **group by** operation on the `first_name` & `last_name` attributes at the application layer to get the exact result that we want!
How about making these steps truly declarative?
With HoneyEQL, we can do it as
```clojure
(heql/query-single
db-adapter
{[:actor/actor-id 148]
[:actor/first-name
:actor/last-name
{:actor/films
[:film/title]}]})
```
The above query **yields the results in the exact-shape that we wanted** and **without any** explicit data transformations.
```clojure
{:actor/first-name "EMILY"
:actor/last-name "DEE"
:actor/films [{:film/title "ANONYMOUS HUMAN"}
{:film/title "BASIC EASY"}
{:film/title "CHAMBER ITALIAN"}
...]}
```
As the query syntax is made up of Clojure's data structures, we can construct it **dynamically** at runtime.
HoneyEQL transforms the EQL into single efficient SQL and queries the database using [next.jdbc](https://github.com/seancorfield/next-jdbc).
## Documentation
[](https://cljdoc.org/d/com.github.tamizhvendan/honeyeql/CURRENT)
## Running Tests
```bash
> ./test/database/start.sh # starts four docker containers
> clj -X:test # run after all the docker container started running
> ./test/database/stop.sh # stops all the four running docker containers
```
## Acknowledgements
[Walkable](https://walkable.gitlab.io/) is the inspiration behind HoneyEQL.
HoneyEQL is not possible without the following excellent Clojure libraries.
- [HoneySQL](https://github.com/jkk/honeysql)
- [next-jdbc](https://github.com/seancorfield/next-jdbc)
- [inflections](https://github.com/r0man/inflections-clj)
- [data-json](https://github.com/clojure/data.json)
The samples in the documentation of HoneyEQL use the [Sakila](https://www.jooq.org/sakila) database from [JOOQ](https://www.jooq.org) extensively.
## License
The use and distribution terms for this software are covered by the [Eclipse Public License - v 2.0](https://www.eclipse.org/legal/epl-2.0). By using this software in any fashion, you are agreeing to be bound by the terms of this license.