Skip to content

Commit 74e972f

Browse files
committed
Update README to reflect current feature set
The README listed several implemented features as unsupported (prepared statements, query cancellation, SSL/TLS) and referenced the wrong SSL dependency (net_ssl instead of ssl). Also missing any mention of SCRAM-SHA-256 auth and the examples directory.
1 parent 2aa8eee commit 74e972f

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,41 @@ Please note that if this library encounters a state that the programmers thought
1818
* `use "postgres"` to include this package
1919
* `corral run -- ponyc` to compile your application
2020

21-
This library has a transitive dependency on [ponylang/net_ssl](https://github.com/ponylang/net_ssl). It requires a C SSL library to be installed. Please see the [net_ssl installation instructions](https://github.com/ponylang/net_ssl?tab=readme-ov-file#installation) for more information.
21+
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.
2222

2323
## API Documentation
2424

2525
[https://ponylang.github.io/postgres](https://ponylang.github.io/postgres)
2626

27+
## Examples
28+
29+
The [examples](examples/) directory contains self-contained programs demonstrating different parts of the library. See [examples/README.md](examples/README.md) for descriptions.
30+
2731
## Postgres API Support
2832

2933
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.
3034

3135
### Authentication
3236

33-
Only MD5 password authentication is supported. KerberosV5, cleartext, SCM, GSS, SSPI, and SASL authentication methods are not supported.
37+
MD5 password and SCRAM-SHA-256 authentication are supported. SCRAM-SHA-256 is the default authentication method in PostgreSQL 10 and later.
38+
39+
KerberosV5, cleartext, SCM, GSS, SSPI, SCRAM-SHA-256-PLUS (channel binding), and certificate authentication methods are not supported.
40+
41+
### SSL/TLS
42+
43+
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.
3444

3545
### Commands
3646

37-
Basic API commands related to querying are supported at this time. Some functionality that isn't yet supported is:
47+
Simple queries, parameterized queries (extended query protocol), named prepared statements, and query cancellation are supported.
48+
49+
Some functionality that isn't yet supported is:
3850

3951
* Supplying connection configuration to the server
40-
* Prepared statements (aka Extended Queries)
4152
* Pipelining queries
4253
* Function calls
4354
* COPY operations
44-
* Cancelling in progress requests
45-
* Session encryption
55+
* LISTEN/NOTIFY
4656

4757
Note the appearance of an item on the above list isn't a guarantee that it will be supported in the future.
4858

0 commit comments

Comments
 (0)