Skip to content

Commit a12d09f

Browse files
authored
Add docc catalog (#311)
1 parent e277f93 commit a12d09f

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# ``PostgresNIO``
2+
3+
🐘 Non-blocking, event-driven Swift client for PostgreSQL built on [SwiftNIO].
4+
5+
## Overview
6+
7+
Features:
8+
9+
- A ``PostgresConnection`` which allows you to connect to, authorize with, query, and retrieve results from a PostgreSQL server
10+
- An async/await interface that supports backpressure
11+
- Automatic conversions between Swift primitive types and the Postgres wire format
12+
- Integrated with the Swift server ecosystem, including use of [SwiftLog].
13+
- Designed to run efficiently on all supported platforms (tested extensively on Linux and Darwin systems)
14+
- Support for `Network.framework` when available (e.g. on Apple platforms)
15+
16+
## Topics
17+
18+
### Connections
19+
20+
- ``PostgresConnection``
21+
22+
### Querying
23+
24+
- ``PostgresQuery``
25+
- ``PostgresBindings``
26+
- ``PostgresRow``
27+
- ``PostgresRowSequence``
28+
- ``PostgresRandomAccessRow``
29+
- ``PostgresCell``
30+
- ``PreparedQuery``
31+
- ``PostgresQueryMetadata``
32+
33+
### Encoding and Decoding
34+
35+
- ``PostgresEncodable``
36+
- ``PostgresEncodingContext``
37+
- ``PostgresDecodable``
38+
- ``PostgresDecodingContext``
39+
- ``PostgresArrayEncodable``
40+
- ``PostgresArrayDecodable``
41+
- ``PostgresJSONEncoder``
42+
- ``PostgresJSONDecoder``
43+
- ``PostgresDataType``
44+
- ``PostgresNumeric``
45+
46+
### Notifications
47+
48+
- ``PostgresListenContext``
49+
50+
### Errors
51+
52+
- ``PostgresError``
53+
- ``PostgresDecodingError``
54+
55+
### Deprecated
56+
57+
These types are already deprecated or will be deprecated in the near future. All of them will be
58+
removed from the public API with the next major release.
59+
60+
- ``PostgresDatabase``
61+
- ``PostgresData``
62+
- ``PostgresDataConvertible``
63+
- ``PostgresQueryResult``
64+
- ``PostgresJSONCodable``
65+
- ``PostgresJSONBCodable``
66+
- ``PostgresMessageEncoder``
67+
- ``PostgresMessageDecoder``
68+
- ``PostgresRequest``
69+
- ``PostgresMessage``
70+
- ``PostgresMessageType``
71+
- ``SASLAuthenticationManager``
72+
- ``SASLAuthenticationMechanism``
73+
74+
[SwiftNIO]: https://github.com/apple/swift-nio
75+
[SwiftLog]: https://github.com/apple/swift-log

0 commit comments

Comments
 (0)