Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/finagle/finagle-postgres
PostgreSQL protocol support for Finagle
https://github.com/finagle/finagle-postgres
Last synced: 9 days ago
JSON representation
PostgreSQL protocol support for Finagle
- Host: GitHub
- URL: https://github.com/finagle/finagle-postgres
- Owner: finagle
- License: apache-2.0
- Created: 2015-03-10T16:01:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T22:07:32.000Z (about 1 year ago)
- Last Synced: 2024-08-01T17:27:01.468Z (3 months ago)
- Language: Scala
- Size: 1.17 MB
- Stars: 81
- Watchers: 9
- Forks: 39
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-scala - Finagle ★ 42 ⧗ 71 - PostgreSQL protocol support for Finagle (Database)
- awesome-scala - finagle-postgres - postgres)  (Table of Contents / Database)
README
# Finagle Postgres
[](http://travis-ci.org/finagle/finagle-postgres)
[](https://maven-badges.herokuapp.com/maven-central/io.github.finagle/finagle-postgres_2.12)
[](https://gitter.im/finagle/finagle-postgres?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
This library provides [PostgreSQL][postgres] database support for
[Finagle][finagle].
[postgres]: https://www.postgresql.org/
[finagle]: https://github.com/twitter/finagle
[mairbek]: https://github.com/mairbek/finagle-postgres
[thefactory]: https://github.com/thefactory/finagle-postgres
[vkostyukov]: https://github.com/vkostyukov/finagle-postgres
## Documentation
See [the GitHub Pages](https://finagle.github.io/finagle-postgres)
## Using the Postgres client
### Installation
Finagle Postgres is published on Maven Central. Use the following _sbt_ snippet to bring it as a
dependency.
```scala
libraryDependencies ++= Seq(
"io.github.finagle" %% "finagle-postgres" % "0.12.0"
)
```
### Connecting to the DB
```scala
val client = Postgres.Client()
.withCredentials("user", Some("password"))
.database("dbname")
.withSessionPool.maxSize(1) //optional; default is unbounded
.withBinaryResults(true)
.withBinaryParams(true)
.withTransport.tls("host")
.newRichClient("host:port")
```
### Selecting with simple query
```scala
val f = client.select("select * from users") {row =>
User(row.getString("email"), row.getString("name"))
}
logger.debug("Responded " + Await.result(f))
```
### Integration Tests
`sbt test` won't run integration tests by default. In order to make it easier for development, a database environment is provided via Docker.
After installing [Docker](https://docs.docker.com/v17.09/engine/installation/) and [docker compose](https://docs.docker.com/compose/install/), run:
```bash
docker-compose up -d
```
A few environment variables need to be provided as well:
```bash
export PG_HOST_PORT=localhost:5432 PG_DBNAME=finagle_postgres_test PG_USER=postgres
```
With the database and variables in place, all tests will be executed. More details in [IntegrationSpec](https://github.com/finagle/finagle-postgres/blob/master/src/test/scala/com/twitter/finagle/postgres/integration/IntegrationSpec.scala#L19-L32)
## Changelog
See [CHANGELOG.md](CHANGELOG.md)
## Contributors
* [Mairbek Khadikov][mairbek] (project creator)
* [The Factory][thefactory]
* [Vladimir Kostyukov][vkostyukov]
* [Jeremy Smith](https://github.com/jeremyrsmith)
* [Leon Maia](https://github.com/leonmaia) (current maintainer)
## License
Licensed under the **[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)** (the "License");
you may not use this software except in compliance with the License.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.