diff --git a/postgres/CHANGELOG.md b/postgres/CHANGELOG.md new file mode 100644 index 000000000..1bfc907dc --- /dev/null +++ b/postgres/CHANGELOG.md @@ -0,0 +1,98 @@ +# Change Log + +## [Unreleased] + +## [v0.16.0-rc.1] - 2019-04-06 + +### Changed + +* `Connection` has been renamed to `Client`. +* The `Client` type is now a thin wrapper around the tokio-postgres nonblocking client. By default, this is handled + transparently by spawning connections onto an internal tokio `Runtime`, but this can also be controlled explicitly. +* The `ConnectParams` type and `IntoConnectParams` trait have been replaced by a builder-style `Config` type. + + Before: + ```rust + let params = ConnectParams::builder() + .user("postgres", None) + .build(Host::Tcp("localhost".to_string())) + .build(); + let conn = Connection::connect(params, &TlsMode::None)?; + ``` + After: + ```rust + let client = Client::configure() + .user("postgres") + .host("localhost") + .connect(NoTls)?; + ``` +* The TLS connection mode (e.g. `prefer`) is now part of the connection configuration instead of being passed in + separately. + + Before: + ```rust + let conn = Connection::connect("postgres://postgres@localhost", &TlsMode::Prefer(connector))?; + ``` + After: + ```rust + let client = Client::connect("postgres://postgres@localhost?sslmode=prefer", connector)?; + ``` +* `Client` and `Transaction` methods take `&mut self` rather than `&self`, and correct use of the active transaction is + verified at compile time rather than runtime. +* `Row` no longer borrows any data. +* `Statement` is now a "token" which is passed into methods on `Client` and `Transaction` and does not borrow the + client: + + Before: + ```rust + let statement = conn.prepare("SELECT * FROM foo WHERE bar = $1")?; + let rows = statement.query(&[&1i32])?; + ``` + After: + ```rust + let statement = client.prepare("SELECT * FROM foo WHERE bar = $1")?; + let rows = client.query(&statement, &[1i32])?; + ``` +* `Statement::lazy_query` has been replaced with `Transaction::bind`, which returns a `Portal` type that can be used + with `Transaction::query_portal`. +* `Statement::copy_in` and `Statement::copy_out` have been moved to `Client` and `Transaction`. +* `Client::copy_out` and `Transaction::copy_out` now return a `Read`er rather than consuming in a `Write`r. +* `Connection::batch_execute` and `Transaction::batch_execute` have been replaced with `Client::simple_query` and + `Transaction::simple_query`. +* The Cargo features enabling `ToSql` and `FromSql` implementations for external crates are now versioned. For example, + `with-uuid` is now `with-uuid-0_7`. This enables us to add support for new major versions of the crates in parallel + without breaking backwards compatibility. + +### Added + +* Connection string configuration now more fully mirrors libpq's syntax, and supports both URL-style and key-value style + strings. +* `FromSql` implementations can now borrow from the data buffer. In particular, this means that you can deserialize + values as `&str`. The `FromSqlOwned` trait can be used as a bound to restrict code to deserializing owned values. +* Added support for channel binding with SCRAM authentication. +* Added multi-host support in connection configuration. +* Added support for simple query requests returning row data. +* Added variants of query methods which return fallible iterators of values and avoid fully buffering the response in + memory. + +### Removed + +* The `with-openssl` and `with-native-tls` Cargo features have been removed. Use the `tokio-postgres-openssl` and + `tokio-postgres-native-tls` crates instead. +* The `with-rustc_serialize` and `with-time` Cargo features have been removed. Use `serde` and `SystemTime` or `chrono` + instead. +* The `Transaction::set_commit` and `Transaction::set_rollback` methods have been removed. The only way to commit a + transaction is to explicitly consume it via `Transaction::commit`. +* The `Rows` type has been removed; methods now return `Vec` instead. +* `Connection::prepare_cache` has been removed, as `Statement` is now `'static` and can be more easily cached + externally. +* Some other slightly more obscure features have been removed in the initial release. If you depended on them, please + file an issue and we can find the right design to add them back! + +## Older + +Look at the [release tags] for information about older releases. + +[Unreleased]: https://github.com/sfackler/rust-postgres/compare/postgres-v0.16.0-rc.1...master +[v0.16.0-rc.1]: https://github.com/sfackler/rust-postgres/compare/postgres-v0.15.2...postgres-v0.16.0-rc.1 +[release tags]: https://github.com/sfackler/rust-postgres/releases diff --git a/postgres/Cargo.toml b/postgres/Cargo.toml index 211ae7218..dc9292072 100644 --- a/postgres/Cargo.toml +++ b/postgres/Cargo.toml @@ -1,12 +1,23 @@ [package] name = "postgres" -version = "0.1.0" +version = "0.16.0-rc.1" authors = ["Steven Fackler "] edition = "2018" +license = "MIT/Apache-2.0" +description = "A native, synchronous PostgreSQL client" +repository = "https://github.com/sfackler/rust-postgres" +readme = "../README.md" +keywords = ["database", "postgres", "postgresql", "sql"] +categories = ["database"] + +[package.metadata.docs.rs] +all-features = true + +[badges] +circle-ci = { repository = "sfackler/rust-postgres" } [features] default = ["runtime"] - runtime = ["tokio-postgres/runtime", "tokio", "lazy_static", "log"] "with-bit-vec-0_5" = ["tokio-postgres/with-bit-vec-0_5"] diff --git a/postgres/LICENSE-APACHE b/postgres/LICENSE-APACHE new file mode 100644 index 000000000..16fe87b06 --- /dev/null +++ b/postgres/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/postgres/LICENSE-MIT b/postgres/LICENSE-MIT new file mode 100644 index 000000000..71803aea1 --- /dev/null +++ b/postgres/LICENSE-MIT @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2016 Steven Fackler + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/postgres/src/lib.rs b/postgres/src/lib.rs index f643db6ed..c4305a2ce 100644 --- a/postgres/src/lib.rs +++ b/postgres/src/lib.rs @@ -52,6 +52,7 @@ //! as an argument. The `NoTls` type in this crate can be used when TLS is not required. Otherwise, the //! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `openssl` and //! `native-tls` crates, respectively. +#![doc(html_root_url = "https://docs.rs/postgres/0.16.0-rc.1")] #![warn(clippy::all, rust_2018_idioms, missing_docs)] #[cfg(feature = "runtime")] diff --git a/tokio-postgres-native-tls/Cargo.toml b/tokio-postgres-native-tls/Cargo.toml index ec1da558a..ec2b91069 100644 --- a/tokio-postgres-native-tls/Cargo.toml +++ b/tokio-postgres-native-tls/Cargo.toml @@ -24,4 +24,4 @@ tokio-postgres = { version = "0.4.0-rc.1", path = "../tokio-postgres", default-f [dev-dependencies] tokio = "0.1.7" -postgres = { version = "0.1.0", path = "../postgres" } +postgres = { version = "0.16.0-rc.1", path = "../postgres" } diff --git a/tokio-postgres-openssl/Cargo.toml b/tokio-postgres-openssl/Cargo.toml index 0ba6a8639..8e1ba0750 100644 --- a/tokio-postgres-openssl/Cargo.toml +++ b/tokio-postgres-openssl/Cargo.toml @@ -24,4 +24,4 @@ tokio-postgres = { version = "0.4.0-rc.1", path = "../tokio-postgres", default-f [dev-dependencies] tokio = "0.1.7" -postgres = { version = "0.1", path = "../postgres" } +postgres = { version = "0.16.0-rc.1", path = "../postgres" } diff --git a/tokio-postgres/CHANGELOG.md b/tokio-postgres/CHANGELOG.md index 22b5197be..6b833bccc 100644 --- a/tokio-postgres/CHANGELOG.md +++ b/tokio-postgres/CHANGELOG.md @@ -14,8 +14,6 @@ * The client API has been significantly overhauled. It now resembles `hyper`'s, with separate `Connection` and `Client` objects. See the crate-level documentation for more details. -* Connection string configuration now fully mirrors libpq's syntax, and supports both URL-style and key-value style - strings. * The TLS connection mode (e.g. `prefer`) is now part of the connection configuration rather than being passed in separately. * The Cargo features enabling `ToSql` and `FromSql` implementations for external crates are now versioned. For example, @@ -25,6 +23,8 @@ ### Added +* Connection string configuration now more fully mirrors libpq's syntax, and supports both URL-style and key-value style + strings. * `FromSql` implementations can now borrow from the data buffer. In particular, this means that you can deserialize values as `&str`. The `FromSqlOwned` trait can be used as a bound to restrict code to deserializing owned values. * Added support for channel binding with SCRAM authentication.