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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
use super::{
as_handle::AsHandle,
bind::{CDataMut, DelayedInput, HasDataType},
buffer::{clamp_small_int, mut_buf_ptr},
column_description::{ColumnDescription, Nullability},
data_type::DataType,
drop_handle,
sql_char::{binary_length, is_truncated_bin, resize_to_fit_without_tz},
sql_result::ExtSqlReturn,
CData, SqlChar, SqlResult, SqlText,
};
use odbc_sys::{
Desc, FreeStmtOption, HDbc, HStmt, Handle, HandleType, Len, ParamType, Pointer, SQLBindCol,
SQLBindParameter, SQLCloseCursor, SQLDescribeParam, SQLExecute, SQLFetch, SQLFreeStmt,
SQLGetData, SQLNumResultCols, SQLParamData, SQLPutData, SqlDataType, SqlReturn,
StatementAttribute, IS_POINTER,
};
use std::{ffi::c_void, marker::PhantomData, mem::ManuallyDrop, ptr::null_mut};
#[cfg(feature = "narrow")]
use odbc_sys::{
SQLColAttribute as sql_col_attribute, SQLColumns as sql_columns,
SQLDescribeCol as sql_describe_col, SQLExecDirect as sql_exec_direc, SQLPrepare as sql_prepare,
SQLSetStmtAttr as sql_set_stmt_attr, SQLTables as sql_tables,
};
#[cfg(not(feature = "narrow"))]
use odbc_sys::{
SQLColAttributeW as sql_col_attribute, SQLColumnsW as sql_columns,
SQLDescribeColW as sql_describe_col, SQLExecDirectW as sql_exec_direc,
SQLPrepareW as sql_prepare, SQLSetStmtAttrW as sql_set_stmt_attr, SQLTablesW as sql_tables,
};
/// Wraps a valid (i.e. successfully allocated) ODBC statement handle.
pub struct StatementImpl<'s> {
parent: PhantomData<&'s HDbc>,
handle: HStmt,
}
unsafe impl<'c> AsHandle for StatementImpl<'c> {
fn as_handle(&self) -> Handle {
self.handle as Handle
}
fn handle_type(&self) -> HandleType {
HandleType::Stmt
}
}
impl<'s> Drop for StatementImpl<'s> {
fn drop(&mut self) {
unsafe {
drop_handle(self.handle as Handle, HandleType::Stmt);
}
}
}
impl<'s> StatementImpl<'s> {
/// # Safety
///
/// `handle` must be a valid (successfully allocated) statement handle.
pub unsafe fn new(handle: HStmt) -> Self {
Self {
handle,
parent: PhantomData,
}
}
/// Transfer ownership of this statement to a raw system handle. It is the users responsibility
/// to call [`crate::sys::SQLFreeHandle`].
pub fn into_sys(self) -> HStmt {
// We do not want to run the drop handler, but transfer ownership instead.
ManuallyDrop::new(self).handle
}
}
/// An ODBC statement handle. In this crate it is implemented by [`self::StatementImpl`]. In ODBC
/// Statements are used to execute statements and retrieve results. Both parameter and result
/// buffers are bound to the statement and dereferenced during statement execution and fetching
/// results.
///
/// The trait allows us to reason about statements without taking the lifetime of their connection
/// into account. It also allows for the trait to be implemented by a handle taking ownership of
/// both, the statement and the connection.
pub trait Statement: AsHandle {
/// Gain access to the underlying statement handle without transferring ownership to it.
fn as_sys(&self) -> HStmt;
/// 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.
unsafe fn bind_col(&mut self, column_number: u16, target: &mut impl CDataMut) -> SqlResult<()> {
SQLBindCol(
self.as_sys(),
column_number,
target.cdata_type(),
target.mut_value_ptr(),
target.buffer_length(),
target.mut_indicator_ptr(),
)
.into_sql_result("SQLBindCol")
}
/// Returns the next row set in the result set.
///
/// It can be called only while a result set exists: I.e., after a call that creates a result
/// set and before the cursor over that result set is closed. 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`.
///
/// # Safety
///
/// Fetch dereferences bound column pointers.
unsafe fn fetch(&mut self) -> Option<SqlResult<()>> {
SQLFetch(self.as_sys()).into_opt_sql_result("SQLFetch")
}
/// Retrieves data for a single column in the result set or for a single parameter.
fn get_data(&mut self, col_or_param_num: u16, target: &mut impl CDataMut) -> SqlResult<()> {
unsafe {
SQLGetData(
self.as_sys(),
col_or_param_num,
target.cdata_type(),
target.mut_value_ptr(),
target.buffer_length(),
target.mut_indicator_ptr(),
)
}
.into_sql_result("SQLGetData")
}
/// Release all column buffers bound by `bind_col`. Except bookmark column.
fn unbind_cols(&mut self) -> SqlResult<()> {
unsafe { SQLFreeStmt(self.as_sys(), FreeStmtOption::Unbind) }.into_sql_result("SQLFreeStmt")
}
/// Bind an integer to hold the number of rows retrieved with fetch in the current row set.
/// Passing `None` for `num_rows` is going to unbind the value from the statement.
///
/// # Safety
///
/// `num_rows` must not be moved and remain valid, as long as it remains bound to the cursor.
unsafe fn set_num_rows_fetched(&mut self, num_rows: Option<&mut usize>) -> SqlResult<()> {
let value = num_rows
.map(|r| r as *mut usize as Pointer)
.unwrap_or_else(null_mut);
sql_set_stmt_attr(
self.as_sys(),
StatementAttribute::RowsFetchedPtr,
value,
IS_POINTER,
)
.into_sql_result("SQLSetStmtAttr")
}
/// 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.
fn describe_col(
&self,
column_number: u16,
column_description: &mut ColumnDescription,
) -> SqlResult<()> {
let name = &mut column_description.name;
// Use maximum available capacity.
name.resize(name.capacity(), 0);
let mut name_length: i16 = 0;
let mut data_type = SqlDataType::UNKNOWN_TYPE;
let mut column_size = 0;
let mut decimal_digits = 0;
let mut nullable = odbc_sys::Nullability::UNKNOWN;
let res = unsafe {
sql_describe_col(
self.as_sys(),
column_number,
mut_buf_ptr(name),
clamp_small_int(name.len()),
&mut name_length,
&mut data_type,
&mut column_size,
&mut decimal_digits,
&mut nullable,
)
.into_sql_result("SQLDescribeCol")
};
if res.is_err() {
return res;
}
column_description.nullability = Nullability::new(nullable);
if name_length + 1 > clamp_small_int(name.len()) {
// Buffer is to small to hold name, retry with larger buffer
name.resize(name_length as usize + 1, 0);
self.describe_col(column_number, column_description)
} else {
name.resize(name_length as usize, 0);
column_description.data_type = DataType::new(data_type, column_size, decimal_digits);
res
}
}
/// Executes a statement, using the current values of the parameter marker variables if any
/// parameters exist in the statement. SQLExecDirect is the fastest way to submit an SQL
/// statement for one-time execution.
///
/// # Safety
///
/// While `self` as always guaranteed to be a valid allocated handle, this function may
/// dereference bound parameters. It is the callers responsibility to ensure these are still
/// valid. One strategy is to reset potentially invalid parameters right before the call using
/// `reset_parameters`.
///
/// # Return
///
/// Returns `true` if execution requires additional data from delayed parameters.
unsafe fn exec_direct(&mut self, statement: &SqlText) -> SqlResult<bool> {
match sql_exec_direc(
self.as_sys(),
statement.ptr(),
statement.len_char().try_into().unwrap(),
) {
SqlReturn::NEED_DATA => SqlResult::Success(true),
// A searched update or delete statement that does not affect any rows at the data
// source.
SqlReturn::NO_DATA => SqlResult::Success(false),
other => other.into_sql_result("SQLExecDirect").on_success(|| false),
}
}
/// Close an open cursor.
fn close_cursor(&mut self) -> SqlResult<()> {
unsafe { SQLCloseCursor(self.as_sys()) }.into_sql_result("SQLCloseCursor")
}
/// Send an SQL statement to the data source for preparation. The application can include one or
/// more parameter markers in the SQL statement. To include a parameter marker, the application
/// embeds a question mark (?) into the SQL string at the appropriate position.
fn prepare(&mut self, statement: &SqlText) -> SqlResult<()> {
unsafe {
sql_prepare(
self.as_sys(),
statement.ptr(),
statement.len_char().try_into().unwrap(),
)
}
.into_sql_result("SQLPrepare")
}
/// Executes a statement prepared by `prepare`. After the application processes or discards the
/// results from a call to `execute`, the application can call SQLExecute again with new
/// parameter values.
///
/// # Safety
///
/// While `self` as always guaranteed to be a valid allocated handle, this function may
/// dereference bound parameters. It is the callers responsibility to ensure these are still
/// valid. One strategy is to reset potentially invalid parameters right before the call using
/// `reset_parameters`.
///
/// # Return
///
/// `true` if data from a delayed parameter is needed.
unsafe fn execute(&mut self) -> SqlResult<bool> {
match SQLExecute(self.as_sys()) {
SqlReturn::NEED_DATA => SqlResult::Success(true),
// A searched update or delete statement that does not affect any rows at the data
// source.
SqlReturn::NO_DATA => SqlResult::Success(false),
other => other.into_sql_result("SQLExecute").on_success(|| false),
}
}
/// Number of columns in result set.
///
/// Can also be used to check, whether or not a result set has been created at all.
fn num_result_cols(&self) -> SqlResult<i16> {
let mut out: i16 = 0;
unsafe { SQLNumResultCols(self.as_sys(), &mut out) }
.into_sql_result("SQLNumResultCols")
.on_success(|| out)
}
/// 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.
unsafe fn set_row_array_size(&mut self, size: usize) -> SqlResult<()> {
assert!(size > 0);
sql_set_stmt_attr(
self.as_sys(),
StatementAttribute::RowArraySize,
size as Pointer,
0,
)
.into_sql_result("SQLSetStmtAttr")
}
/// Specifies the number of values for each parameter. If it is greater than 1, the data and
/// indicator buffers of the statement point to arrays. The cardinality of each array is equal
/// to the value of this field.
///
/// # Safety
///
/// The bound buffers must at least hold the number of elements specified in this call then the
/// statement is executed.
unsafe fn set_paramset_size(&mut self, size: usize) -> SqlResult<()> {
assert!(size > 0);
sql_set_stmt_attr(
self.as_sys(),
StatementAttribute::ParamsetSize,
size as Pointer,
0,
)
.into_sql_result("SQLSetStmtAttr")
}
/// 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.
unsafe fn set_row_bind_type(&mut self, row_size: usize) -> SqlResult<()> {
sql_set_stmt_attr(
self.as_sys(),
StatementAttribute::RowBindType,
row_size as Pointer,
0,
)
.into_sql_result("SQLSetStmtAttr")
}
fn set_metadata_id(&mut self, metadata_id: bool) -> SqlResult<()> {
unsafe {
sql_set_stmt_attr(
self.as_sys(),
StatementAttribute::MetadataId,
metadata_id as usize as Pointer,
0,
)
.into_sql_result("SQLSetStmtAttr")
}
}
/// Binds a buffer holding an input parameter to a parameter marker in an SQL statement. This
/// specialized version takes a constant reference to parameter, but is therefore limited to
/// binding input parameters. See [`Statement::bind_parameter`] for the version which can bind
/// input and output parameters.
///
/// See <https://docs.microsoft.com/en-us/sql/odbc/reference/syntax/sqlbindparameter-function>.
///
/// # Safety
///
/// * It is up to the caller to ensure the lifetimes of the bound parameters.
/// * Calling this function may influence other statements that share the APD.
unsafe fn bind_input_parameter(
&mut self,
parameter_number: u16,
parameter: &(impl HasDataType + CData + ?Sized),
) -> SqlResult<()> {
let parameter_type = parameter.data_type();
SQLBindParameter(
self.as_sys(),
parameter_number,
ParamType::Input,
parameter.cdata_type(),
parameter_type.data_type(),
parameter_type.column_size(),
parameter_type.decimal_digits(),
// We cast const to mut here, but we specify the input_output_type as input.
parameter.value_ptr() as *mut c_void,
parameter.buffer_length(),
// We cast const to mut here, but we specify the input_output_type as input.
parameter.indicator_ptr() as *mut isize,
)
.into_sql_result("SQLBindParameter")
}
/// Binds a buffer holding a single parameter to a parameter marker in an SQL statement. To bind
/// input parameters using constant references see [`Statement::bind_input_parameter`].
///
/// See <https://docs.microsoft.com/en-us/sql/odbc/reference/syntax/sqlbindparameter-function>.
///
/// # Safety
///
/// * It is up to the caller to ensure the lifetimes of the bound parameters.
/// * Calling this function may influence other statements that share the APD.
unsafe fn bind_parameter(
&mut self,
parameter_number: u16,
input_output_type: ParamType,
parameter: &mut (impl CDataMut + HasDataType),
) -> SqlResult<()> {
let parameter_type = parameter.data_type();
SQLBindParameter(
self.as_sys(),
parameter_number,
input_output_type,
parameter.cdata_type(),
parameter_type.data_type(),
parameter_type.column_size(),
parameter_type.decimal_digits(),
parameter.value_ptr() as *mut c_void,
parameter.buffer_length(),
parameter.mut_indicator_ptr(),
)
.into_sql_result("SQLBindParameter")
}
/// Binds an input stream to a parameter marker in an SQL statement. Use this to stream large
/// values at statement execution time. To bind preallocated constant buffers see
/// [`Statement::bind_input_parameter`].
///
/// See <https://docs.microsoft.com/en-us/sql/odbc/reference/syntax/sqlbindparameter-function>.
///
/// # Safety
///
/// * It is up to the caller to ensure the lifetimes of the bound parameters.
/// * Calling this function may influence other statements that share the APD.
unsafe fn bind_delayed_input_parameter(
&mut self,
parameter_number: u16,
parameter: &mut (impl DelayedInput + HasDataType),
) -> SqlResult<()> {
let paramater_type = parameter.data_type();
SQLBindParameter(
self.as_sys(),
parameter_number,
ParamType::Input,
parameter.cdata_type(),
paramater_type.data_type(),
paramater_type.column_size(),
paramater_type.decimal_digits(),
parameter.stream_ptr(),
0,
// We cast const to mut here, but we specify the input_output_type as input.
parameter.indicator_ptr() as *mut isize,
)
.into_sql_result("SQLBindParameter")
}
/// `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.
fn is_unsigned_column(&self, column_number: u16) -> SqlResult<bool> {
unsafe { self.numeric_col_attribute(Desc::Unsigned, column_number) }.map(|out| match out {
0 => false,
1 => true,
_ => panic!("Unsigned column attribute must be either 0 or 1."),
})
}
/// Returns a number identifying the SQL type of the column in the result set.
///
/// `column_number`: Index of the column, starting at 1.
fn col_type(&self, column_number: u16) -> SqlResult<SqlDataType> {
unsafe { self.numeric_col_attribute(Desc::Type, column_number) }
.map(|ret| SqlDataType(ret.try_into().unwrap()))
}
/// 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.
fn col_concise_type(&self, column_number: u16) -> SqlResult<SqlDataType> {
unsafe { self.numeric_col_attribute(Desc::ConciseType, column_number) }
.map(|ret| SqlDataType(ret.try_into().unwrap()))
}
/// 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.
fn col_octet_length(&self, column_number: u16) -> SqlResult<isize> {
unsafe { self.numeric_col_attribute(Desc::OctetLength, column_number) }
}
/// Maximum number of characters required to display data from the column.
///
/// `column_number`: Index of the column, starting at 1.
fn col_display_size(&self, column_number: u16) -> SqlResult<isize> {
unsafe { self.numeric_col_attribute(Desc::DisplaySize, 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.
fn col_precision(&self, column_number: u16) -> SqlResult<isize> {
unsafe { self.numeric_col_attribute(Desc::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.
fn col_scale(&self, column_number: u16) -> SqlResult<Len> {
unsafe { self.numeric_col_attribute(Desc::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.
fn col_name(&self, column_number: u16, buffer: &mut Vec<SqlChar>) -> SqlResult<()> {
// String length in bytes, not characters. Terminating zero is excluded.
let mut string_length_in_bytes: i16 = 0;
// Let's utilize all of `buf`s capacity.
buffer.resize(buffer.capacity(), 0);
unsafe {
let mut res = sql_col_attribute(
self.as_sys(),
column_number,
Desc::Name,
mut_buf_ptr(buffer) as Pointer,
binary_length(buffer).try_into().unwrap(),
&mut string_length_in_bytes as *mut i16,
null_mut(),
)
.into_sql_result("SQLColAttribute");
if res.is_err() {
return res;
}
if is_truncated_bin(buffer, string_length_in_bytes.try_into().unwrap()) {
// If we could rely on every ODBC driver sticking to the specifcation it would
// probably best to resize by `string_length_in_bytes / 2 + 1`. Yet e.g. SQLite
// seems to report the length in characters, so to work with a wide range of DB
// systems, and since buffers for names are not expected to become super large we
// ommit the division by two here.
buffer.resize((string_length_in_bytes + 1).try_into().unwrap(), 0);
res = sql_col_attribute(
self.as_sys(),
column_number,
Desc::Name,
mut_buf_ptr(buffer) as Pointer,
binary_length(buffer).try_into().unwrap(),
&mut string_length_in_bytes as *mut i16,
null_mut(),
)
.into_sql_result("SQLColAttribute");
}
// Resize buffer to exact string length without terminal zero
resize_to_fit_without_tz(buffer, string_length_in_bytes.try_into().unwrap());
res
}
}
/// # Safety
///
/// It is the callers responsibility to ensure that `attribute` refers to a numeric attribute.
unsafe fn numeric_col_attribute(&self, attribute: Desc, column_number: u16) -> SqlResult<Len> {
let mut out: Len = 0;
sql_col_attribute(
self.as_sys(),
column_number,
attribute,
null_mut(),
0,
null_mut(),
&mut out as *mut Len,
)
.into_sql_result("SQLColAttribute")
.on_success(|| out)
}
/// Sets the SQL_DESC_COUNT field of the APD to 0, releasing all parameter buffers set for the
/// given StatementHandle.
fn reset_parameters(&mut self) -> SqlResult<()> {
unsafe {
SQLFreeStmt(self.as_sys(), FreeStmtOption::ResetParams).into_sql_result("SQLFreeStmt")
}
}
/// Describes parameter marker associated with a prepared SQL statement.
///
/// # Parameters
///
/// * `parameter_number`: Parameter marker number ordered sequentially in increasing parameter
/// order, starting at 1.
fn describe_param(&self, parameter_number: u16) -> SqlResult<ParameterDescription> {
let mut data_type = SqlDataType::UNKNOWN_TYPE;
let mut parameter_size = 0;
let mut decimal_digits = 0;
let mut nullable = odbc_sys::Nullability::UNKNOWN;
unsafe {
SQLDescribeParam(
self.as_sys(),
parameter_number,
&mut data_type,
&mut parameter_size,
&mut decimal_digits,
&mut nullable,
)
}
.into_sql_result("SQLDescribeParam")
.on_success(|| ParameterDescription {
data_type: DataType::new(data_type, parameter_size, decimal_digits),
nullable: Nullability::new(nullable),
})
}
/// Use to check if which additional parameters need data. Should be called after binding
/// parameters with an indicator set to [`crate::sys::DATA_AT_EXEC`] or a value created with
/// [`crate::sys::len_data_at_exec`].
///
/// Return value contains a parameter identifier passed to bind parameter as a value pointer.
fn param_data(&mut self) -> SqlResult<Option<Pointer>> {
unsafe {
let mut param_id: Pointer = null_mut();
// Use cases for `PARAM_DATA_AVAILABLE` and `NO_DATA` not implemented yet.
match SQLParamData(self.as_sys(), &mut param_id as *mut Pointer) {
SqlReturn::NEED_DATA => SqlResult::Success(Some(param_id)),
other => other.into_sql_result("SQLParamData").on_success(|| None),
}
}
}
/// Executes a columns query using this statement handle.
fn columns(
&mut self,
catalog_name: &SqlText,
schema_name: &SqlText,
table_name: &SqlText,
column_name: &SqlText,
) -> SqlResult<()> {
unsafe {
sql_columns(
self.as_sys(),
catalog_name.ptr(),
catalog_name.len_char().try_into().unwrap(),
schema_name.ptr(),
schema_name.len_char().try_into().unwrap(),
table_name.ptr(),
table_name.len_char().try_into().unwrap(),
column_name.ptr(),
column_name.len_char().try_into().unwrap(),
)
.into_sql_result("SQLColumns")
}
}
/// Returns the list of table, catalog, or schema names, and table types, stored in a specific
/// data source. The driver returns the information as a result set.
///
/// The catalog, schema and table parameters are search patterns by default unless
/// [`Self::set_metadata_id`] is called with `true`. In that case they must also not be `None` since
/// otherwise a NulPointer error is emitted.
fn tables(
&mut self,
catalog_name: &SqlText,
schema_name: &SqlText,
table_name: &SqlText,
table_type: &SqlText,
) -> SqlResult<()> {
unsafe {
sql_tables(
self.as_sys(),
catalog_name.ptr(),
catalog_name.len_char().try_into().unwrap(),
schema_name.ptr(),
schema_name.len_char().try_into().unwrap(),
table_name.ptr(),
table_name.len_char().try_into().unwrap(),
table_type.ptr(),
table_type.len_char().try_into().unwrap(),
)
.into_sql_result("SQLTables")
}
}
/// To put a batch of binary data into the data source at statement execution time. Returns true
/// if the `NEED_DATA` is returned by the driver.
///
/// Panics if batch is empty.
fn put_binary_batch(&mut self, batch: &[u8]) -> SqlResult<bool> {
// Probably not strictly necessary. MSSQL returns an error than inserting empty batches.
// Still strikes me as a programming error. Maybe we could also do nothing instead.
if batch.is_empty() {
panic!("Attempt to put empty batch into data source.")
}
unsafe {
match SQLPutData(
self.as_sys(),
batch.as_ptr() as Pointer,
batch.len().try_into().unwrap(),
) {
SqlReturn::NEED_DATA => SqlResult::Success(true),
other => other.into_sql_result("SQLPutData").on_success(|| false),
}
}
}
}
impl<'o> Statement for StatementImpl<'o> {
/// Gain access to the underlying statement handle without transferring ownership to it.
fn as_sys(&self) -> HStmt {
self.handle
}
}
/// Description of a parameter associated with a parameter marker in a prepared statement. Returned
/// by [`crate::Prepared::describe_param`].
#[derive(Debug)]
pub struct ParameterDescription {
// Todo: rename to nullability.
/// Indicates whether the parameter may be NULL not.
pub nullable: Nullability,
/// The SQL Type associated with that parameter.
pub data_type: DataType,
}