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 745 746 747 748 749 750 751 752 753 754 755 756 757 758
//! Session Pool
#[cfg(feature="blocking")]
#[cfg_attr(docsrs, doc(cfg(feature="blocking")))]
mod blocking;
#[cfg(feature="nonblocking")]
#[cfg_attr(docsrs, doc(cfg(feature="nonblocking")))]
mod nonblocking;
use std::{sync::Arc, marker::PhantomData};
use crate::{Error, Result, oci::*, Environment};
/**
Internal (Arc protected) details of a session pool.
This ensures that the OCI pool is still accessible when nonblocking [`SessionPool::get_svc_ctx()`]
is still running while the task that called [`SessionPool::get_session()`] has been already destroyed.
*/
pub(crate) struct SPool {
name: Vec<u8>,
pool: Handle<OCISPool>,
info: Handle<OCIAuthInfo>,
err: Handle<OCIError>,
env: Arc<Handle<OCIEnv>>,
}
impl Drop for SPool {
fn drop(&mut self) {
let _ = &self.info;
oci_session_pool_destroy(&self.pool, &self.err);
}
}
#[cfg(feature="nonblocking")]
impl SPool {
pub(crate) fn get_env(&self) -> Arc<Handle<OCIEnv>> {
self.env.clone()
}
pub(crate) fn get_name(&self) -> &[u8] {
&self.name
}
}
/**
Session pool creates and maintains a group of stateless sessions to the database.
These sessions are provided to the application as requested. If no sessions are
available, a new one may be created. Thus, the number of sessions in the pool
can increase dynamically. When the application is done (DROPS) with the session,
it is returned to the pool.
*/
pub struct SessionPool<'a> {
inner: Arc<SPool>,
phantom_env: PhantomData<&'a Environment>
}
/**
Represents the behavior of the session pool when all sessions in the pool
are found to be busy and the number of sessions has reached the maximum or
the pool must create new connections.
*/
#[derive(Debug, PartialEq, Eq)]
pub enum SessionPoolGetMode {
/// The thread waits and blocks until a session is freed or a new one is created. This is the default value.
Wait = 0,
/// An error is returned if there are no free connections or if the pool must create a new connection.
NoWait,
/**
A new session is created even though all the sessions are busy and the maximum number of sessions has been reached.
**Note** that if this value is set, it is possible that there can be an attempt to create more sessions than can be
supported by the instance of the Oracle database.
*/
ForcedGet,
/// Keep trying internally for a free session until the time out expires.
TimedWait,
}
impl SessionPool<'_> {
pub(crate) fn get_spool(&self) -> Arc<SPool> {
self.inner.clone()
}
#[cfg(feature="blocking")]
pub(crate) fn get_env(&self) -> Arc<Handle<OCIEnv>> {
self.inner.env.clone()
}
/**
Returns the number of sessions checked out from the pool.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 2, 2, 10)?;
let num_busy = pool.busy_count()?;
assert_eq!(num_busy, 0);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 2, 2, 10).await?;
# let num_busy = pool.busy_count()?;
# assert_eq!(num_busy, 0);
# Ok(()) })
# }
```
*/
pub fn busy_count(&self) -> Result<usize> {
let count : u32 = self.inner.pool.get_attr(OCI_ATTR_SPOOL_BUSY_COUNT, &self.inner.err)?;
Ok(count as usize)
}
/**
Returns the number of open sessions.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 2, 2, 10)?;
let num_sessions = pool.open_count()?;
assert_eq!(num_sessions, 2);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 2, 2, 10).await?;
# let num_sessions = pool.open_count()?;
# assert_eq!(num_sessions, 2);
# Ok(()) })
# }
```
*/
pub fn open_count(&self) -> Result<usize> {
let count : u32 = self.inner.pool.get_attr(OCI_ATTR_SPOOL_OPEN_COUNT, &self.inner.err)?;
Ok(count as usize)
}
/**
Returns the "get mode" or the behavior of the session pool when all sessions in the pool
are found to be busy and the number of sessions has reached the maximum.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
use sibyl::SessionPoolGetMode;
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
let get_mode = pool.get_mode()?;
assert_eq!(get_mode, SessionPoolGetMode::Wait);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# let get_mode = pool.get_mode()?;
# assert_eq!(get_mode, SessionPoolGetMode::Wait);
# Ok(()) })
# }
```
*/
pub fn get_mode(&self) -> Result<SessionPoolGetMode> {
let mode : u8 = self.inner.pool.get_attr(OCI_ATTR_SPOOL_GETMODE, &self.inner.err)?;
match mode {
OCI_SPOOL_ATTRVAL_WAIT => Ok(SessionPoolGetMode::Wait),
OCI_SPOOL_ATTRVAL_NOWAIT => Ok(SessionPoolGetMode::NoWait),
OCI_SPOOL_ATTRVAL_FORCEGET => Ok(SessionPoolGetMode::ForcedGet),
OCI_SPOOL_ATTRVAL_TIMEDWAIT => Ok(SessionPoolGetMode::TimedWait),
_ => Err(Error::new("unknown get mmode returned"))
}
}
/**
Sets "get mode" or the behavior of the session pool when all sessions in the pool
are found to be busy and the number of sessions has reached the maximum.
# Parameters
* `mode` - new pool "get mode"
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
use sibyl::SessionPoolGetMode;
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
pool.set_get_mode(SessionPoolGetMode::ForcedGet)?;
# let get_mode = pool.get_mode()?;
# assert_eq!(get_mode, SessionPoolGetMode::ForcedGet);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# pool.set_get_mode(SessionPoolGetMode::ForcedGet)?;
# let get_mode = pool.get_mode()?;
# assert_eq!(get_mode, SessionPoolGetMode::ForcedGet);
# Ok(()) })
# }
```
*/
pub fn set_get_mode(&self, mode: SessionPoolGetMode) -> Result<()> {
self.inner.pool.set_attr(OCI_ATTR_SPOOL_GETMODE, mode as u8, &self.inner.err)
}
/**
Returns the maximum time (in milliseconds) [`SessionPool::get_session()`] would wait
for a free session when "get mode" is set to [`SessionPoolGetMode::TimedWait`].
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
let get_session_max_wait_time = pool.wait_timeout()?;
// The out-of-the-box "wait timeout" (on 64-bit Linux, Instant Client 19.13)
// is 5000 ms. This, however, is not documented anywhere. So, there might be
// a chance that other OCI implementations would set it to a different value.
assert_eq!(get_session_max_wait_time, 5000);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# let get_session_max_wait_time = pool.wait_timeout()?;
# assert_eq!(get_session_max_wait_time, 5000);
# Ok(()) })
# }
```
*/
pub fn wait_timeout(&self) -> Result<u32> {
self.inner.pool.get_attr(OCI_ATTR_SPOOL_WAIT_TIMEOUT, &self.inner.err)
}
/**
Sets the maximum time (in milliseconds) [`SessionPool::get_session()`] would wait
for a free session when "get mode" is set to [`SessionPoolGetMode::TimedWait`].
# Parameters
* `milliseconds` - "get session" wait timeout.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
pool.set_wait_timeout(1000)?;
# let wait_timeout = pool.wait_timeout()?;
# assert_eq!(wait_timeout, 1000);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# pool.set_wait_timeout(1000)?;
# let wait_timeout = pool.wait_timeout()?;
# assert_eq!(wait_timeout, 1000);
# Ok(()) })
# }
```
*/
pub fn set_wait_timeout(&self, milliseconds: u32) -> Result<()> {
self.inner.pool.set_attr(OCI_ATTR_SPOOL_WAIT_TIMEOUT, milliseconds, &self.inner.err)
}
/**
Returns maximum idle time for sessions (in seconds).
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
let session_max_idle_time = pool.idle_timeout()?;
assert_eq!(session_max_idle_time, 0);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# let session_max_idle_time = pool.idle_timeout()?;
# assert_eq!(session_max_idle_time, 0);
# Ok(()) })
# }
```
*/
pub fn idle_timeout(&self) -> Result<u32> {
self.inner.pool.get_attr(OCI_ATTR_SPOOL_TIMEOUT, &self.inner.err)
}
/**
Sets maximum idle time for sessions (in seconds).
Sessions that are idle for more than this time are terminated periodically to maintain
an optimum number of open sessions. If this attribute is not set, the least recently
used sessions may be timed out if and when space in the pool is required.
The idle sessions are checked when a busy one is released back to the pool.
# Parameters
* `seconds` - maximum session idle time
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 1, 1, 10)?;
pool.set_idle_timeout(600);
# let timeout = pool.idle_timeout()?;
# assert_eq!(timeout, 600, "pool idle timeout");
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 1, 1, 10).await?;
# pool.set_idle_timeout(600)?;
# let timeout = pool.idle_timeout()?;
# assert_eq!(timeout, 600);
# Ok(()) })
# }
```
*/
pub fn set_idle_timeout(&self, seconds: u32) -> Result<()> {
self.inner.pool.set_attr(OCI_ATTR_SPOOL_TIMEOUT, seconds, &self.inner.err)
}
/**
Returns the lifetime (in seconds) for all the sessions in the pool.
Sessions in the pool are terminated when they have reached or exceeded their lifetime.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
let max_lifetime = pool.session_max_lifetime()?;
assert_eq!(max_lifetime, 0);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# let max_lifetime = pool.session_max_lifetime()?;
# assert_eq!(max_lifetime, 0);
# Ok(()) })
# }
```
*/
pub fn session_max_lifetime(&self) -> Result<u32> {
self.inner.pool.get_attr(OCI_ATTR_SPOOL_MAX_LIFETIME_SESSION, &self.inner.err)
}
/**
Sets the lifetime (in seconds) for all the sessions in the pool.
Sessions in the pool are terminated when they have reached or exceeded their lifetime.
# Parameters
* `seconds` - duration of the session lifetime
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
pool.set_session_max_lifetime(10 * 3600)?;
# let max_lifetime = pool.session_max_lifetime()?;
# assert_eq!(max_lifetime, 10 * 3600);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# pool.set_session_max_lifetime(10 * 3600)?;
# let max_lifetime = pool.session_max_lifetime()?;
# assert_eq!(max_lifetime, 10 * 3600);
# Ok(()) })
# }
```
*/
pub fn set_session_max_lifetime(&self, seconds: u32) -> Result<()> {
self.inner.pool.set_attr(OCI_ATTR_SPOOL_MAX_LIFETIME_SESSION, seconds, &self.inner.err)
}
/**
Returns the maximum number of times one session can be checked out of the session pool.
After that the session is automatically destroyed. The default value is 0, which means
there is no limit.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
let max_use_count = pool.session_max_use_count()?;
assert_eq!(max_use_count, 0);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# let max_use_count = pool.session_max_use_count()?;
# assert_eq!(max_use_count, 0);
# Ok(()) })
# }
```
*/
pub fn session_max_use_count(&self) -> Result<u32> {
self.inner.pool.get_attr(OCI_ATTR_SPOOL_MAX_USE_SESSION, &self.inner.err)
}
/**
Sets the maximum number of times one session can be checked out of the session pool.
# Parameters
* `count` - The maximum number of times one session can be checked out of the session pool.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
pool.set_session_max_use_count(10_000)?;
# let max_use_count = pool.session_max_use_count()?;
# assert_eq!(max_use_count, 10_000);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# pool.set_session_max_use_count(10_000)?;
# let max_use_count = pool.session_max_use_count()?;
# assert_eq!(max_use_count, 10_000);
# Ok(()) })
# }
```
*/
pub fn set_session_max_use_count(&self, count: u32) -> Result<()> {
self.inner.pool.set_attr(OCI_ATTR_SPOOL_MAX_USE_SESSION, count, &self.inner.err)
}
/**
Returns the default statement cache size (in number of statements). The default value is 20.
When an application asks for a session from a session pool, the statement cache size
for that session defaults to that of the pool.
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 1, 1, 10)?;
let cache_size = pool.statement_cache_size()?;
assert_eq!(cache_size, 20);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 1, 1, 10).await?;
# let cache_size = pool.statement_cache_size()?;
# assert_eq!(cache_size, 20);
# Ok(()) })
# }
```
*/
pub fn statement_cache_size(&self) -> Result<u32> {
self.inner.pool.get_attr(OCI_ATTR_SPOOL_STMTCACHESIZE, &self.inner.err)
}
/**
Sets the default statement cache size (in number of statements) .
The change is reflected on individual sessions in the pool, when they are provided to a user.
# Parameters
* `size` - cache size in number of statements
# Example
🛈 **Note** that this example is written for `blocking` mode execution. Add `await`s, where needed,
to convert it to a nonblocking variant (or peek at the source to see the hidden nonblocking doctest).
```
# use sibyl::Result;
# #[cfg(feature="blocking")]
# fn main() -> Result<()> {
# let oracle = sibyl::env()?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10)?;
pool.set_statement_cache_size(100)?;
# let cache_size = pool.statement_cache_size()?;
# assert_eq!(cache_size, 100);
# Ok(())
# }
# #[cfg(feature="nonblocking")]
# fn main() -> Result<()> {
# sibyl::block_on(async {
# use once_cell::sync::OnceCell;
# static ORACLE: OnceCell<sibyl::Environment> = OnceCell::new();
# let oracle = ORACLE.get_or_try_init(|| sibyl::Environment::new())?;
# let dbname = std::env::var("DBNAME").expect("database name");
# let dbuser = std::env::var("DBUSER").expect("user name");
# let dbpass = std::env::var("DBPASS").expect("password");
# let pool = oracle.create_session_pool(&dbname, &dbuser, &dbpass, 0, 1, 10).await?;
# pool.set_statement_cache_size(100)?;
# let cache_size = pool.statement_cache_size()?;
# assert_eq!(cache_size, 100);
# Ok(()) })
# }
```
*/
pub fn set_statement_cache_size(&self, size: u32) -> Result<()> {
self.inner.pool.set_attr(OCI_ATTR_SPOOL_STMTCACHESIZE, size, &self.inner.err)
}
}