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
// Rust-oracle - Rust binding for Oracle database // // URL: https://github.com/kubo/rust-oracle // //----------------------------------------------------------------------------- // Copyright (c) 2017-2019 Kubo Takehiro <kubo@jiubao.org>. All rights reserved. // This program is free software: you can modify it and/or redistribute it // under the terms of: // // (i) the Universal Permissive License v 1.0 or at your option, any // later version (http://oss.oracle.com/licenses/upl); and/or // // (ii) the Apache License v 2.0. (http://www.apache.org/licenses/LICENSE-2.0) //----------------------------------------------------------------------------- /*! This is an [Oracle database][] driver for [Rust][] based on [ODPI-C][]. Applications using Rust-oracle 0.1.x should use 0.2.x. The incompatibility between 0.1.x and 0.2.x is trivial so they will work well without modification. The author continues updating 0.2.x to fix bugs as long as it doesn't introduce incompatibilities. New features are added in Rust-oracle 0.3.x or later. There are enormous incompatibilities between 0.2.x and 0.3.x. They were introduced to follow Rust way. Some parameters were removed and builder data types were added instead. Some types were moved to a new module `sql_type`. Rust-oracle 0.4.x will include breaking changes about [query methods](https://github.com/kubo/rust-oracle/blob/master/docs/query-methods.md). The query methods with `as` may be renamed to and merged into methods without `as`. The `params` argument of `Connection.prepare` will be replaced with some kind of the builder pattern. ## Change Log See [ChangeLog.md](https://github.com/kubo/rust-oracle/blob/master/ChangeLog.md). ## Build-time Requirements * Rust 1.31.0 or later for rust-oracle 0.3.0 and later. * Rust 1.19.0 or later for rust-oarcle 0.1.x and 0.2.x. * C compiler. See `Compile-time Requirements` in [this document](https://github.com/alexcrichton/cc-rs#compile-time-requirements). ## Run-time Requirements * Oracle client 11.2 or later. See [ODPI-C installation document][]. ## Usage Put this in your `Cargo.toml`: ```text [dependencies] oracle = "0.3.0" ``` When you need to fetch or bind [chrono](https://docs.rs/chrono/0.4/chrono/) data types, enable `chrono` feature: ```text [dependencies] oracle = { version = "0.3.0", features = ["chrono"] } ``` Then put this in your crate root: ```rust extern crate oracle; ``` ## Examples Executes select statements and get rows: ```no_run # use oracle::*; fn try_main() -> Result<()> { // Connect to a database. let conn = Connection::connect("scott", "tiger", "//localhost/XE")?; let sql = "select ename, sal, comm from emp where deptno = :1"; // Select a table with a bind variable. println!("---------------|---------------|---------------|"); let rows = conn.query(sql, &[&30])?; for row_result in rows { let row = row_result?; // get a column value by position (0-based) let ename: String = row.get(0)?; // get a column by name (case-insensitive) let sal: i32 = row.get("sal")?; // Use `Option<...>` to get a nullable column. // Otherwise, `Err(Error::NullValue)` is returned // for null values. let comm: Option<i32> = row.get(2)?; println!(" {:14}| {:>10} | {:>10} |", ename, sal, comm.map_or("".to_string(), |v| v.to_string())); } // Another way to fetch rows. // The rows iterator returns Result<(String, i32, Option<i32>)>. println!("---------------|---------------|---------------|"); let rows = conn.query_as::<(String, i32, Option<i32>)>(sql, &[&10])?; for row_result in rows { let (ename, sal, comm) = row_result?; println!(" {:14}| {:>10} | {:>10} |", ename, sal, comm.map_or("".to_string(), |v| v.to_string())); } # Ok(())} fn main() { try_main().unwrap(); } ``` Executes select statements and get the first rows: ```no_run # use oracle::*; fn try_main() -> Result<()> { use oracle::Connection; // Connect to a database. let conn = Connection::connect("scott", "tiger", "//localhost/XE")?; let sql = "select ename, sal, comm from emp where empno = :1"; // Print the first row. let row = conn.query_row(sql, &[&7369])?; let ename: String = row.get("empno")?; let sal: i32 = row.get("sal")?; let comm: Option<i32> = row.get("comm")?; println!("---------------|---------------|---------------|"); println!(" {:14}| {:>10} | {:>10} |", ename, sal, comm.map_or("".to_string(), |v| v.to_string())); // When no rows are found, conn.query_row() returns `Err(Error::NoDataFound)`. // Get the first row as a tupple let row = conn.query_row_as::<(String, i32, Option<i32>)>(sql, &[&7566])?; println!("---------------|---------------|---------------|"); println!(" {:14}| {:>10} | {:>10} |", row.0, row.1, row.2.map_or("".to_string(), |v| v.to_string())); # Ok(())} fn main() { try_main().unwrap(); } ``` Executes non-select statements: ```no_run # use oracle::*; fn try_main() -> Result<()> { use oracle::Connection; // Connect to a database. let conn = Connection::connect("scott", "tiger", "//localhost/XE")?; conn.execute("create table person (id number(38), name varchar2(40))", &[])?; // Execute a statement with positional parameters. conn.execute("insert into person values (:1, :2)", &[&1, // first parameter &"John" // second parameter ])?; // Execute a statement with named parameters. conn.execute_named("insert into person values (:id, :name)", &[("id", &2), // 'id' parameter ("name", &"Smith"), // 'name' parameter ])?; // Commit the transaction. conn.commit()?; // Delete rows conn.execute("delete from person", &[])?; // Rollback the transaction. conn.rollback()?; # Ok(())} fn main() { try_main().unwrap(); } ``` Prints column information: ```no_run # use oracle::*; fn try_main() -> Result<()> { use oracle::Connection; // Connect to a database. let conn = Connection::connect("scott", "tiger", "//localhost/XE")?; let sql = "select ename, sal, comm from emp where 1 = 2"; let rows = conn.query(sql, &[])?; // Print column names for info in rows.column_info() { print!(" {:14}|", info.name()); } println!(""); // Print column types for info in rows.column_info() { print!(" {:14}|", info.oracle_type().to_string()); } println!(""); # Ok(())} fn main() { try_main().unwrap(); } ``` Prepared statement: ```no_run # use oracle::*; fn try_main() -> Result<()> { use oracle::Connection; let conn = Connection::connect("scott", "tiger", "//localhost/XE")?; // Create a prepared statement let mut stmt = conn.prepare("insert into person values (:1, :2)", &[])?; // Insert one row stmt.execute(&[&1, &"John"])?; // Insert another row stmt.execute(&[&2, &"Smith"])?; # Ok(())} fn main() { try_main().unwrap(); } ``` This is more efficient than two `conn.execute()`. An SQL statement is executed in the DBMS as follows: * step 1. Parse the SQL statement and create an execution plan. * step 2. Execute the plan with bind parameters. When a prepared statement is used, step 1 is called only once. ## NLS_LANG parameter [NLS_LANG][] consists of three components: [language][], [territory][] and charset. However the charset component is ignored and UTF-8(AL32UTF8) is used as charset because rust characters are UTF-8. The territory component specifies numeric format, date format and so on. However it affects only conversion in Oracle. See the following example: ```no_run # use oracle::*; fn try_main() -> Result<()> { use oracle::Connection; // The territory is France. std::env::set_var("NLS_LANG", "french_france.AL32UTF8"); let conn = Connection::connect("scott", "tiger", "")?; // 10.1 is converted to a string in Oracle and fetched as a string. let result = conn.query_row_as::<String>("select to_char(10.1) from dual", &[])?; assert_eq!(result, "10,1"); // The decimal mark depends on the territory. // 10.1 is fetched as a number and converted to a string in rust-oracle let result = conn.query_row_as::<String>("select 10.1 from dual", &[])?; assert_eq!(result, "10.1"); // The decimal mark is always period(.). # Ok(())} fn main() { try_main().unwrap(); } ``` Note that NLS_LANG must be set before first rust-oracle function execution if required. ## TODO * Connection pooling * Read and write LOB as stream * REF CURSOR, BOOLEAN * Scrollable cursors * Batch DML * Better Oracle object type support ## License Rust-oracle and ODPI-C bundled in rust-oracle are under the terms of: 1. [the Universal Permissive License v 1.0 or at your option, any later version](http://oss.oracle.com/licenses/upl); and/or 2. [the Apache License v 2.0](http://www.apache.org/licenses/LICENSE-2.0). [Rust]: https://www.rust-lang.org/ [ODPI-C]: https://oracle.github.io/odpi/ [ODPI-C installation document]: https://oracle.github.io/odpi/doc/installation.html [Oracle database]: https://www.oracle.com/database/index.html [NLS_LANG]: http://www.oracle.com/technetwork/products/globalization/nls-lang-099431.html [language]: http://www.oracle.com/technetwork/database/database-technologies/globalization/nls-lang-099431.html#_Toc110410559 [territory]: http://www.oracle.com/technetwork/database/database-technologies/globalization/nls-lang-099431.html#_Toc110410560 */ use lazy_static::lazy_static; use std::os::raw::c_char; use std::ptr; use std::result; use std::slice; #[allow(dead_code)] #[allow(non_camel_case_types)] #[allow(non_snake_case)] #[allow(improper_ctypes)] mod binding; mod connection; mod error; mod row; pub mod sql_type; mod sql_value; mod statement; mod util; mod version; pub use crate::connection::ConnStatus; pub use crate::connection::Connection; pub use crate::connection::Connector; pub use crate::connection::Privilege; pub use crate::connection::ShutdownMode; pub use crate::connection::StartupMode; pub use crate::error::DbError; pub use crate::error::Error; pub use crate::error::ParseOracleTypeError; pub use crate::row::ResultSet; pub use crate::row::Row; pub use crate::row::RowValue; pub use crate::sql_value::SqlValue; pub use crate::statement::BindIndex; pub use crate::statement::ColumnIndex; pub use crate::statement::ColumnInfo; pub use crate::statement::Statement; pub use crate::statement::StatementType; pub use crate::statement::StmtParam; pub use crate::version::Version; use crate::binding::*; pub type Result<T> = result::Result<T, Error>; macro_rules! define_dpi_data_with_refcount { ($name:ident) => { paste::item! { struct [<Dpi $name>] { raw: *mut [<dpi $name>], } impl [<Dpi $name>] { fn new(raw: *mut [<dpi $name>]) -> [<Dpi $name>] { [<Dpi $name>] { raw: raw } } #[allow(dead_code)] fn with_add_ref(raw: *mut [<dpi $name>]) -> [<Dpi $name>] { unsafe { [<dpi $name _addRef>](raw) }; [<Dpi $name>] { raw: raw } } pub(crate) fn raw(&self) -> *mut [<dpi $name>] { self.raw } } impl Clone for [<Dpi $name>] { fn clone(&self) -> [<Dpi $name>] { unsafe { [<dpi $name _addRef>](self.raw()) }; [<Dpi $name>]::new(self.raw()) } } impl Drop for [<Dpi $name>] { fn drop(&mut self) { unsafe { [<dpi $name _release>](self.raw()) }; } } unsafe impl Send for [<Dpi $name>] {} unsafe impl Sync for [<Dpi $name>] {} } }; } // define DpiConn wrapping *mut dpiConn. define_dpi_data_with_refcount!(Conn); // define DpiObjectType wrapping *mut dpiObjectType. define_dpi_data_with_refcount!(ObjectType); // define DpiObjectAttr wrapping *mut dpiObjectAttr. define_dpi_data_with_refcount!(ObjectAttr); // // Context // struct Context { pub context: *mut dpiContext, pub common_create_params: dpiCommonCreateParams, pub conn_create_params: dpiConnCreateParams, pub pool_create_params: dpiPoolCreateParams, pub subscr_create_params: dpiSubscrCreateParams, } unsafe impl Sync for Context {} unsafe impl Send for Context {} enum ContextResult { Ok(Context), Err(dpiErrorInfo), } unsafe impl Sync for ContextResult {} unsafe impl Send for ContextResult {} trait AssertSend: Send {} trait AssertSync: Sync {} lazy_static! { static ref DPI_CONTEXT: ContextResult = { let mut ctxt = Context { context: ptr::null_mut(), common_create_params: Default::default(), conn_create_params: Default::default(), pool_create_params: Default::default(), subscr_create_params: Default::default(), }; let mut err: dpiErrorInfo = Default::default(); if unsafe { dpiContext_create( DPI_MAJOR_VERSION, DPI_MINOR_VERSION, &mut ctxt.context, &mut err, ) } == DPI_SUCCESS as i32 { unsafe { let utf8_ptr = "UTF-8\0".as_ptr() as *const c_char; let driver_name = concat!("rust-oracle : ", env!("CARGO_PKG_VERSION")); let driver_name_ptr = driver_name.as_ptr() as *const c_char; let driver_name_len = driver_name.len() as u32; dpiContext_initCommonCreateParams(ctxt.context, &mut ctxt.common_create_params); dpiContext_initConnCreateParams(ctxt.context, &mut ctxt.conn_create_params); dpiContext_initPoolCreateParams(ctxt.context, &mut ctxt.pool_create_params); dpiContext_initSubscrCreateParams(ctxt.context, &mut ctxt.subscr_create_params); ctxt.common_create_params.createMode |= DPI_MODE_CREATE_THREADED; ctxt.common_create_params.encoding = utf8_ptr; ctxt.common_create_params.nencoding = utf8_ptr; ctxt.common_create_params.driverName = driver_name_ptr; ctxt.common_create_params.driverNameLength = driver_name_len; } ContextResult::Ok(ctxt) } else { ContextResult::Err(err) } }; } impl Context { pub fn get() -> Result<&'static Context> { match *DPI_CONTEXT { ContextResult::Ok(ref ctxt) => Ok(ctxt), ContextResult::Err(ref err) => Err(error::error_from_dpi_error(err)), } } } // // Default value definitions // impl Default for dpiCommonCreateParams { fn default() -> dpiCommonCreateParams { dpiCommonCreateParams { createMode: DPI_MODE_CREATE_DEFAULT, encoding: ptr::null(), nencoding: ptr::null(), edition: ptr::null(), editionLength: 0, driverName: ptr::null(), driverNameLength: 0, } } } impl Default for dpiConnCreateParams { fn default() -> dpiConnCreateParams { dpiConnCreateParams { authMode: DPI_MODE_AUTH_DEFAULT, connectionClass: ptr::null(), connectionClassLength: 0, purity: 0, newPassword: ptr::null(), newPasswordLength: 0, appContext: ptr::null_mut(), numAppContext: 0, externalAuth: 0, externalHandle: ptr::null_mut(), pool: ptr::null_mut(), tag: ptr::null(), tagLength: 0, matchAnyTag: 0, outTag: ptr::null(), outTagLength: 0, outTagFound: 0, shardingKeyColumns: ptr::null_mut(), numShardingKeyColumns: 0, superShardingKeyColumns: ptr::null_mut(), numSuperShardingKeyColumns: 0, outNewSession: 0, } } } impl Default for dpiData { fn default() -> dpiData { dpiData { isNull: 0, value: dpiDataBuffer { asInt64: 0 }, } } } impl Default for dpiPoolCreateParams { fn default() -> dpiPoolCreateParams { dpiPoolCreateParams { minSessions: 0, maxSessions: 0, sessionIncrement: 0, pingInterval: 0, pingTimeout: 0, homogeneous: 0, externalAuth: 0, getMode: 0, outPoolName: ptr::null(), outPoolNameLength: 0, timeout: 0, waitTimeout: 0, maxLifetimeSession: 0, plsqlFixupCallback: ptr::null(), plsqlFixupCallbackLength: 0, } } } impl Default for dpiSubscrCreateParams { fn default() -> dpiSubscrCreateParams { dpiSubscrCreateParams { subscrNamespace: 0, protocol: 0, qos: 0, operations: 0, portNumber: 0, timeout: 0, name: ptr::null(), nameLength: 0, callback: None, callbackContext: ptr::null_mut(), recipientName: ptr::null(), recipientNameLength: 0, ipAddress: ptr::null_mut(), ipAddressLength: 0, groupingClass: 0, groupingValue: 0, groupingType: 0, outRegId: 0, } } } impl Default for dpiErrorInfo { fn default() -> dpiErrorInfo { dpiErrorInfo { code: 0, offset: 0, message: ptr::null(), messageLength: 0, encoding: ptr::null(), fnName: ptr::null(), action: ptr::null(), sqlState: ptr::null(), isRecoverable: 0, } } } impl Default for dpiDataTypeInfo { fn default() -> dpiDataTypeInfo { dpiDataTypeInfo { oracleTypeNum: 0, defaultNativeTypeNum: 0, ociTypeCode: 0, dbSizeInBytes: 0, clientSizeInBytes: 0, sizeInChars: 0, precision: 0, scale: 0, fsPrecision: 0, objectType: ptr::null_mut(), } } } impl Default for dpiObjectAttrInfo { fn default() -> dpiObjectAttrInfo { dpiObjectAttrInfo { name: ptr::null(), nameLength: 0, typeInfo: Default::default(), } } } impl Default for dpiObjectTypeInfo { fn default() -> dpiObjectTypeInfo { dpiObjectTypeInfo { schema: ptr::null(), schemaLength: 0, name: ptr::null(), nameLength: 0, isCollection: 0, elementTypeInfo: Default::default(), numAttributes: 0, } } } impl Default for dpiQueryInfo { fn default() -> dpiQueryInfo { dpiQueryInfo { name: ptr::null(), nameLength: 0, typeInfo: Default::default(), nullOk: 0, } } } impl Default for dpiVersionInfo { fn default() -> dpiVersionInfo { dpiVersionInfo { versionNum: 0, releaseNum: 0, updateNum: 0, portReleaseNum: 0, portUpdateNum: 0, fullVersionNum: 0, } } } impl Default for dpiStmtInfo { fn default() -> dpiStmtInfo { dpiStmtInfo { isQuery: 0, isPLSQL: 0, isDDL: 0, isDML: 0, statementType: 0, isReturning: 0, } } } // // Utility struct to convert Rust strings from/to ODPI-C strings // struct OdpiStr { pub ptr: *const c_char, pub len: u32, } fn new_odpi_str() -> OdpiStr { OdpiStr { ptr: ptr::null(), len: 0, } } fn to_odpi_str(s: &str) -> OdpiStr { if s.len() == 0 { OdpiStr { ptr: ptr::null(), len: 0, } } else { OdpiStr { ptr: s.as_ptr() as *const c_char, len: s.len() as u32, } } } impl OdpiStr { pub fn to_string(&self) -> String { to_rust_str(self.ptr, self.len) } } fn to_rust_str(ptr: *const c_char, len: u32) -> String { if ptr.is_null() { "".to_string() } else { let s = unsafe { slice::from_raw_parts(ptr as *mut u8, len as usize) }; String::from_utf8_lossy(s).into_owned() } } fn to_rust_slice<'a>(ptr: *const c_char, len: u32) -> &'a [u8] { if ptr.is_null() { &[] } else { unsafe { slice::from_raw_parts(ptr as *mut u8, len as usize) } } } mod private { pub trait Sealed {} impl Sealed for usize {} impl<'a> Sealed for &'a str {} }