Skip to content

Commit

Permalink
extend on arrow_odbc_reader comment
Browse files Browse the repository at this point in the history
  • Loading branch information
pacman82 committed Dec 28, 2023
1 parent 19a7c9d commit a68297c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/reader/arrow_odbc_reader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ use arrow_odbc::{

/// Opaque type holding all the state associated with an ODBC reader implementation in Rust. This
/// type also has ownership of the ODBC Connection handle.
///
/// Originally this type had been intended soley as an opaque handle to the reader. However the
/// design that emerged is that this holds the statement and connection handle in various states.
/// This has several benefits:
///
/// * It allows statetransitions to happen in the Rust part, which is good, because they actually
/// can be triggered by calls to ODBC.
/// * We can keep the C-Interface lean, we just hold a handle to this instance, rather than
/// modelling a lot of different Python wrappers for various states.
/// * Since Python does not posses destructive move semantics, we would not be able to represent
/// the transitions in the Python part well anyway.
pub enum ArrowOdbcReader {
/// The last result set has been extracted from the cursor. There is nothing more to fetch and
/// all associated resources have been deallocated
Expand Down

0 comments on commit a68297c

Please sign in to comment.