https://github.com/ponylang/postgres
Pure Pony Postgres driver
https://github.com/ponylang/postgres
pony-core-team-library ponylang ponylang-langauge postgresql
Last synced: 4 months ago
JSON representation
Pure Pony Postgres driver
- Host: GitHub
- URL: https://github.com/ponylang/postgres
- Owner: ponylang
- License: bsd-2-clause
- Created: 2022-09-30T19:15:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-06T12:54:56.000Z (about 1 year ago)
- Last Synced: 2025-06-20T21:49:23.464Z (about 1 year ago)
- Topics: pony-core-team-library, ponylang, ponylang-langauge, postgresql
- Language: Pony
- Homepage:
- Size: 163 KB
- Stars: 13
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Postgres
Pure Pony Postgres driver
## Status
Postgres is an alpha-level package.
We welcome users who are willing to experience errors and possible application shutdowns. Your feedback on API usage and in reporting bugs is greatly appreciated.
Please note that if this library encounters a state that the programmers thought was impossible to hit, it will exit the program immediately with informational messages. Normal errors are handled in standard Pony fashion.
## Installation
* Install [corral](https://github.com/ponylang/corral)
* `corral add github.com/ponylang/postgres.git --version 0.2.2`
* `corral fetch` to fetch your dependencies
* `use "postgres"` to include this package
* `corral run -- ponyc` to compile your application
This library has a transitive dependency on [ponylang/ssl](https://github.com/ponylang/ssl). It requires a C SSL library to be installed. Please see the [ssl installation instructions](https://github.com/ponylang/ssl?tab=readme-ov-file#installation) for more information.
## API Documentation
[https://ponylang.github.io/postgres](https://ponylang.github.io/postgres)
## Examples
The [examples](examples/) directory contains self-contained programs demonstrating different parts of the library. See [examples/README.md](examples/README.md) for descriptions.
## Postgres API Support
This library aims to support the Postgres API to the level required to use Postgres from Pony in ways that the Pony community needs. We do not aim to support the entire API surface. If there is functionality missing, we will happily accept high-quality pull requests to add additional support so long as they don't come with additional external dependencies or overly burdensome maintenance.
### Authentication
MD5 password and SCRAM-SHA-256 authentication are supported. SCRAM-SHA-256 is the default authentication method in PostgreSQL 10 and later.
KerberosV5, cleartext, SCM, GSS, SSPI, SCRAM-SHA-256-PLUS (channel binding), and certificate authentication methods are not supported.
### SSL/TLS
Optional SSL/TLS encryption is supported. Pass `SSLRequired` with an `SSLContext` to `ServerConnectInfo` to enable encrypted connections. If the server refuses SSL negotiation, the connection fails. Plaintext connections are the default.
### Commands
Simple queries, parameterized queries (extended query protocol), named prepared statements, query cancellation, and LISTEN/NOTIFY are supported.
Some functionality that isn't yet supported is:
* Supplying connection configuration to the server
* Pipelining queries
* Function calls
* COPY operations
Note the appearance of an item on the above list isn't a guarantee that it will be supported in the future.
### Data Types
The following data types are fully supported and will be converted from their postgres type to the corresponding Pony type. All other data types will be presented as `String`.
* `bool` => `Bool`
* `int2` => `I16`
* `int4` => `I32`
* `int8` => `I64`
* `float4` => `F32`
* `float8` => `F64`
As `String` is our default type, all character types such as `text` are returned to the user as `String` and as such, aren't listed in our supported types.