Skip to content
This repository has been archived by the owner on Sep 3, 2023. It is now read-only.

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bobozaur committed Apr 21, 2022
1 parent 5f89742 commit cc4db17
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 18 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@ Please find the documentation [here](https://docs.rs/exasol/latest/exasol/).

Features available:
- DSN parsing and resolving
- Ability to use a custom TLS connector
- Credentials & OpenID token login support
- Single and batch query execution
- Prepared statements
- WSS support through native-tls and rustls
- Compression support
- Compression support through flate2
- Row deserialization into Rust types
- Positional parameter binding
- Named parameter binding
- Autocommit is enabled by default. Disabling it results in transactional mode being enabled, which requires explicit "COMMIT" or "ROLLBACK" statements to be executed.
- Performant single and multithreaded IMPORT/EXPORT features

Features planned for future versions:
- Performant IMPORT/EXPORT functionalities
- Performant parallel IMPORT/EXPORT

## Crate Features:
* native-tls - (disabled by default) enables `tungstenite`'s WSS support through `native-tls`
* rustls - (disabled by default) enables `tungstenite`'s WSS support through `rustls`
* flate2 - (disabled by default) enables support for requests and responses compression
* `native-tls` - (disabled by default) enables `tungstenite` WSS encryption support through native-tls
* `native-tls-vendored` - (disabled by default) enables `tungstenite` WSS encryption support through native-tls-vendored
* `rustls-tls-webpki-roots` - (disabled by default) enables `tungstenite` WSS encryption support through rustls-tls-webpki-roots
* `rustls-tls-native-roots` - (disabled by default) enables `tungstenite` WSS encryption support through rustls-tls-native-roots
* `flate2` - (disabled by default) enables compression support


## License
Expand Down
21 changes: 11 additions & 10 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,10 @@
//! let data: Vec<Vec<String>> = exa_con.iter_result(&mut result).unwrap();
//! ```
//!
//! First 1000 rows get returned immediately and then data is retrieved in chunks in the [ResultSet]
//! instance buffer and only concatenated in the [Connection::fetch_all] method.
//! The buffer size can be changed either in the [ConOpts] or through the [Connection::set_fetch_size] method.
//! A lazier approach can be employed by using [Connection::fetch] instead, controlling
//! thus how many rows are returned.
//! The [Connection::iter_result] method returns a lazy iterator over a result's rows. Only a given
//! rows buffer is present at a given time in a [ResultSet], which is contained in a [QueryResult],
//! if the query had a result set. The buffer size can be changed either in the [ConOpts] or
//! through the [Connection::set_fetch_size] method.
//!
//! # Cleanup
//! [QueryResult] structs will automatically close once fully retrieved. If that does not happen,
Expand Down Expand Up @@ -205,9 +204,11 @@
//!
//! # Features
//!
//! - `native-tls` - (disabled by default) enables `tungstenite` WSS support through native-tls
//! - `rustls` - (disabled by default) enables `tungstenite` WSS support through rustls
//! - `flate2` - (disabled by default) enables support for requests and responses compression
//! - `native-tls` - (disabled by default) enables `tungstenite` WSS encryption support through native-tls
//! - `native-tls-vendored` - (disabled by default) enables `tungstenite` WSS encryption support through native-tls-vendored
//! - `rustls-tls-webpki-roots` - (disabled by default) enables `tungstenite` WSS encryption support through rustls-tls-webpki-roots
//! - `rustls-tls-native-roots` - (disabled by default) enables `tungstenite` WSS encryption support through rustls-tls-native-roots
//! - `flate2` - (disabled by default) enables compression support
//!
//! Enabling these features allows changing additional settings in [ConOpts] instances.
//!
Expand Down Expand Up @@ -241,8 +242,8 @@
//!
//! # HTTP Transport
//!
//! Parallel, highly performant, IMPORT/EXPORT operations are supported through [Connection::export_to_closure]
//! and [Connection::import_from_closure].
//! Parallel, highly performant, IMPORT/EXPORT operations are supported through
//! [Connection::export_to_closure] and [Connection::import_from_closure].
mod con_opts;
mod connection;
Expand Down

0 comments on commit cc4db17

Please sign in to comment.