You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+16-6Lines changed: 16 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,31 +18,41 @@ Please note that if this library encounters a state that the programmers thought
18
18
*`use "postgres"` to include this package
19
19
*`corral run -- ponyc` to compile your application
20
20
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.
The [examples](examples/) directory contains self-contained programs demonstrating different parts of the library. See [examples/README.md](examples/README.md) for descriptions.
30
+
27
31
## Postgres API Support
28
32
29
33
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.
30
34
31
35
### Authentication
32
36
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.
34
44
35
45
### Commands
36
46
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:
38
50
39
51
* Supplying connection configuration to the server
40
-
* Prepared statements (aka Extended Queries)
41
52
* Pipelining queries
42
53
* Function calls
43
54
* COPY operations
44
-
* Cancelling in progress requests
45
-
* Session encryption
55
+
* LISTEN/NOTIFY
46
56
47
57
Note the appearance of an item on the above list isn't a guarantee that it will be supported in the future.
0 commit comments