1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
use crate::{handles::Statement, ColumnDescription, Error}; use odbc_sys::{CDataType, Len, Pointer, SmallInt, UInteger, ULen, USmallInt, SqlDataType, WChar}; use std::thread::panicking; /// Cursors are used to process and iterate the result sets returned by executing queries. pub struct Cursor<'open_connection> { statement: Statement<'open_connection>, } impl<'o> Drop for Cursor<'o> { fn drop(&mut self) { if let Err(e) = self.statement.close_cursor() { // Avoid panicking, if we already have a panic. We don't want to mask the original // error. if !panicking() { panic!("Unexepected error disconnecting: {:?}", e) } } } } impl<'o> Cursor<'o> { pub(crate) fn new(statement: Statement<'o>) -> Self { Self { statement } } /// Fetch a column description using the column index. /// /// # Parameters /// /// * `column_number`: Column index. `0` is the bookmark column. The other column indices start /// with `1`. /// * `column_description`: Holds the description of the column after the call. This method does /// not provide strong exception safety as the value of this argument is undefined in case of an /// error. pub fn describe_col( &self, column_number: USmallInt, column_description: &mut ColumnDescription, ) -> Result<(), Error> { self.statement .describe_col(column_number, column_description)?; Ok(()) } /// Number of columns in result set. pub fn num_result_cols(&self) -> Result<SmallInt, Error> { self.statement.num_result_cols() } /// Returns the next rowset in the result set. /// /// If any columns are bound, it returns the data in those columns. If the application has /// specified a pointer to a row status array or a buffer in which to return the number of rows /// fetched, `fetch` also returns this information. Calls to `fetch` can be mixed with calls to /// `fetch_scroll`. pub fn fetch(&mut self) -> Result<bool, Error> { self.statement.fetch() } /// Sets the batch size for bulk cursors, if retrieving many rows at once. /// /// # Safety /// /// It is the callers responsibility to ensure that buffers bound using `bind_col` can hold the /// specified amount of rows. pub unsafe fn set_row_array_size(&mut self, size: UInteger) -> Result<(), Error> { self.statement.set_row_array_size(size) } /// Bind an integer to hold the number of rows retrieved with fetch in the current row set. /// /// # Safety /// /// `num_rows` must not be moved and remain valid, as long as it remains bound to the cursor. pub unsafe fn set_num_rows_fetched(&mut self, num_rows: &mut ULen) -> Result<(), Error> { self.statement.set_num_rows_fetched(num_rows) } /// Sets the binding type to columnar binding for batch cursors. /// /// Any Positive number indicates a row wise binding with that row length. `0` indicates a /// columnar binding. /// /// # Safety /// /// It is the callers responsibility to ensure that the bound buffers match the memory layout /// specified by this function. pub unsafe fn set_row_bind_type(&mut self, row_size: u32) -> Result<(), Error> { self.statement.set_row_bind_type(row_size) } /// Release all columen buffers bound by `bind_col`. Except bookmark column. pub fn unbind_cols(&mut self) -> Result<(), Error> { self.statement.unbind_cols() } /// Binds application data buffers to columns in the result set /// /// * `column_number`: `0` is the bookmark column. It is not included in some result sets. All /// other columns are numbered starting with `1`. It is an error to bind a higher-numbered /// column than there are columns in the result set. This error cannot be detected until the /// result set has been created, so it is returned by `fetch`, not `bind_col`. /// * `target_type`: The identifier of the C data type of the `value` buffer. When it is /// retrieving data from the data source with `fetch`, the driver converts the data to this /// type. When it sends data to the source, the driver converts the data from this type. /// * `target_value`: Pointer to the data buffer to bind to the column. /// * `target_length`: Length of target value in bytes. (Or for a single element in case of bulk /// aka. block fetching data). /// * `indicator`: Buffer is going to hold length or indicator values. /// /// # Safety /// /// It is the callers responsibility to make sure the bound columns live until they are no /// longer bound. pub unsafe fn bind_col( &mut self, column_number: USmallInt, target_type: CDataType, target_value: Pointer, target_length: Len, indicator: *mut Len, ) -> Result<(), Error> { self.statement.bind_col( column_number, target_type, target_value, target_length, indicator, ) } /// `true` if a given column in a result set is unsigned or not a numeric type, `false` /// otherwise. /// /// `column_number`: Index of the column, starting at 1. pub fn is_unsigned_column(&self, column_number: USmallInt) -> Result<bool, Error> { self.statement.is_unsigned_column(column_number) } /// Binds this cursor to a buffer holding a row set. pub fn bind_row_set_buffer<'b, B>( mut self, row_set_buffer: &'b mut B, ) -> Result<RowSetCursor<'b, 'o, B>, Error> where B: RowSetBuffer, { unsafe { row_set_buffer.bind_to_cursor(&mut self)?; } Ok(RowSetCursor::new(row_set_buffer, self)) } /// SqlDataType /// /// `column_number`: Index of the column, starting at 1. pub fn col_type(&self, column_number: USmallInt) -> Result<SqlDataType, Error> { self.statement.col_type(column_number) } /// The concise data type. For the datetime and interval data types, this field returns the /// concise data type; for example, `TIME` or `INTERVAL_YEAR`. /// /// `column_number`: Index of the column, starting at 1. pub fn col_concise_type(&self, column_number: USmallInt) -> Result<SqlDataType, Error> { self.statement.col_type(column_number) } /// Returns the size in bytes of the columns. For variable sized types the maximum size is /// returned, excluding a terminating zero. /// /// `column_number`: Index of the column, starting at 1. pub fn col_octet_length(&self, column_number: USmallInt) -> Result<Len, Error> { self.statement.col_octet_length(column_number) } /// Maximum number of characters required to display data from the column. /// /// `column_number`: Index of the column, starting at 1. pub fn col_display_size(&self, column_number: USmallInt) -> Result<Len, Error> { self.statement.col_display_size(column_number) } /// Precision of the column. /// /// Denotes the applicable precision. For data types SQL_TYPE_TIME, SQL_TYPE_TIMESTAMP, and all /// the interval data types that represent a time interval, its value is the applicable /// precision of the fractional seconds component. pub fn col_precision(&self, column_number: USmallInt) -> Result<Len, Error> { self.statement.col_precision(column_number) } /// The applicable scale for a numeric data type. For DECIMAL and NUMERIC data types, this is /// the defined scale. It is undefined for all other data types. pub fn col_scale(&self, column_number: USmallInt) -> Result<Len, Error> { self.statement.col_scale(column_number) } /// The column alias, if it applies. If the column alias does not apply, the column name is /// returned. If there is no column name or a column alias, an empty string is returned. pub fn col_name(&self, column_number: USmallInt, buf: &mut Vec<WChar>) -> Result<(), Error> { self.statement.col_name(column_number, buf) } } /// A Row set buffer binds row, or column wise buffers to a cursor in order to fill them with row /// sets with each call to fetch. pub unsafe trait RowSetBuffer { unsafe fn bind_to_cursor(&mut self, cursor: &mut Cursor) -> Result<(), Error>; } /// A row set cursor iterates blockwise over row sets, filling them in buffers, instead of iterating /// the result set row by row. pub struct RowSetCursor<'b, 'o, B> { buffer: &'b mut B, cursor: Cursor<'o>, } impl<'b, 'o, B> RowSetCursor<'b, 'o, B> { fn new(buffer: &'b mut B, cursor: Cursor<'o>) -> Self { Self { buffer, cursor } } /// Fills the bound buffer with the next row set. /// /// # Return /// /// `None` if the result set is empty and all row sets have been extracetd. `Some` with a /// reference to the internal buffer otherwise. pub fn fetch(&mut self) -> Result<Option<&B>, Error> { if self.cursor.fetch()? { Ok(Some(self.buffer)) } else { Ok(None) } } /// Unbind the buffer, leaving the cursor free to bind another buffer to it. pub fn unbind(mut self) -> Result<Cursor<'o>, Error> { self.cursor.unbind_cols()?; Ok(self.cursor) } }