Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/holmusk/postgresql-simple-named
:question: Implementation of named parameters for `postgresql-simple` library
https://github.com/holmusk/postgresql-simple-named
haskell named-parameters postgresql
Last synced: 10 days ago
JSON representation
:question: Implementation of named parameters for `postgresql-simple` library
- Host: GitHub
- URL: https://github.com/holmusk/postgresql-simple-named
- Owner: Holmusk
- License: mpl-2.0
- Created: 2019-07-02T07:36:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-05T14:05:10.000Z (about 1 month ago)
- Last Synced: 2024-10-12T23:08:38.181Z (24 days ago)
- Topics: haskell, named-parameters, postgresql
- Language: Haskell
- Homepage:
- Size: 54.7 KB
- Stars: 38
- Watchers: 15
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# postgresql-simple-named
[](https://github.com/Holmusk/postgresql-simple-named/actions/workflows/haskell-ci.yml)
[](https://hackage.haskell.org/package/postgresql-simple-named)
[](http://stackage.org/lts/package/postgresql-simple-named)
[](http://stackage.org/nightly/package/postgresql-simple-named)
[](LICENSE)
This library introduces the implementation of named parameters for the
[`postgresql-simple`][pgs] library. `postgresql-simple-named` is designed to
be used along with the [`postgresql-simple`][pgs] library, so you could refer
there for the original documentation of primary functions. This package solves
exclusively one particular problem — gives the ability to use named parameters
instead of `?` in quasi-quoter queries and offers essential functions for substituting
variables in queries (`queryNamed`, `executeNamed`).
## Example
Operator `=?` binds named parameters with the corresponding values. Named
parameters inside SQL query start with the '?' character and can contain
lowercase and uppercase letters, digits and underscore. Below you can find a
basic example of how query with named parameters could look like:
```haskell
queryNamed dbConnection [sql|
SELECT
id, name, city
FROM users
WHERE name = ?nameParam
AND age = ?ageParam
|] [ "nameParam" =? "John"
, "ageParam" =? 42
]
```
This feature can be extremely helpful when the query uses some parameters more than once:
```haskell
query dbConnection [sql|
SELECT
col1, col2
FROM my_table
WHERE id = ?
AND (? IS NULL OR id > ? )
AND (? IS NULL OR id < ? )
|] (someId, minId, minId, maxId, maxId)
```
This is how the query looks like with the `postgresql-simple` library. You can
rewrite it the following way using the `postgresql-simple-named` library:
```haskell
queryNamed dbConnection [sql|
SELECT
col1, col2
FROM my_table
WHERE id = ?someId
AND (?minId IS NULL OR id > ?minId )
AND (?maxId IS NULL OR id < ?maxId )
|] [ "someId" =? 42
, "minId" =? 1
, "maxId" =? 100
]
```
## How to build
Build the library with either `cabal new-build` or `stack build`.
## How to test locally
* Run DB in a Docker in a separate terminal window using command:
```bash
docker run -p 5432:5432 -e POSTGRES_PASSWORD=postgres postgres:15
```
* Run tests using `cabal new-test` or `stack test`
[pgs]: https://hackage.haskell.org/package/postgresql-simple