API Collection
Deprecations
PostgresNIO follows SemVer 2.0.0. Learn which APIs are considered deprecated and how to migrate to their replacements.Overview
PostgresNIO reached 1.0 in April 2020. Since then the maintainers have been hard at work to guarantee API stability. However as the Swift and Swift on server ecosystem have matured approaches have changed. The introduction of structured concurrency changed what developers expect from a modern Swift library. Because of this PostgresNIO added various APIs that embrace the new Swift patterns. This means however, that PostgresNIO still offers APIs that have fallen out of favor. Those are documented here. All those APIs will be removed once the maintainers release the next major version. The maintainers recommend all adopters to move of those APIs sooner rather than later.
Topics
Migrate of deprecated APIs
- Adopting the new PostgresRow cell APIThis article describes how to adopt the new
PostgresRowcell APIs in existing Postgres code which use thecolumn(_:)API today.
Deprecated APIs
protocol PostgresDatabasestruct PostgresDataprotocol PostgresDataConvertiblestruct PostgresQueryResultprotocol PostgresJSONCodableprotocol PostgresJSONBCodableclass PostgresMessageEncoderclass PostgresMessageDecoderprotocol PostgresRequestProtocol to encapsulate a function call on the Postgres serverstruct PostgresMessageA frontend or backend Postgres message.protocol PostgresMessageTypetypealias PostgresFormatCodeclass PostgresListenContextContext for receiving NotificationResponse messages on a connection, used for PostgreSQL’sLISTEN/NOTIFYsupport.struct PreparedQueryclass SASLAuthenticationManagerprotocol SASLAuthenticationMechanismThe protocol to which all SASL mechanism implementations must conform. It is the responsibility of each individual implementation to provide an API for creating instances of itself which are able to retrieve information from the caller (such as usernames and passwords) by some mechanism.enum SASLAuthenticationErrorVarious errors that can occur during SASL negotiation that are not specific to the particular SASL mechanism in use.enum SASLAuthenticationStepResultSignifies an action to be taken as the result of a single step of a SASL mechanism.