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
//! OCI environment use crate::*; use libc::{ c_void, size_t }; use std::{ mem, ptr }; // Initialization Modes const OCI_THREADED : u32 = 1; const OCI_OBJECT : u32 = 2; // Attributes const OCI_ATTR_CACHE_OPT_SIZE : u32 = 34; const OCI_ATTR_CACHE_MAX_SIZE : u32 = 35; const OCI_ATTR_ENV_NLS_LANGUAGE : u32 = 424; const OCI_ATTR_ENV_NLS_TERRITORY : u32 = 425; extern "C" { // https://docs.oracle.com/en/database/oracle/oracle-database/19/lnoci/connect-authorize-and-initialize-functions.html#GUID-16BDA1F1-7DAF-41CA-9EE1-C9A4CB467244 fn OCIEnvNlsCreate( envhpp: &*mut OCIEnv, mode: u32, ctxp: *const c_void, malocfp: *const c_void, ralocfp: *const c_void, mfreefp: *const c_void, xtramemsz: size_t, usrmempp: *const c_void, charset: u16, ncharset: u16 ) -> i32; } fn create_environment() -> Result<Handle<OCIEnv>> { let env: *mut OCIEnv; let res = unsafe { env = mem::uninitialized(); OCIEnvNlsCreate( &env, OCI_OBJECT | OCI_THREADED, ptr::null(), ptr::null(), ptr::null(), ptr::null(), 0, ptr::null(), AL32UTF8, UTF8 ) }; if res != OCI_SUCCESS { Err( Error::new("Cannot create OCI environment") ) } else { Ok( Handle::from(env) ) } } /// Represents an OCI environment. pub struct Environment { err: Handle<OCIError>, env: Handle<OCIEnv> } /// A trait for types that provide access to `Environment` handles. /// /// See: [Encapsulating Lifetime of the Field][1] /// /// [1]: https://matklad.github.io/2018/05/04/encapsulating-lifetime-of-the-field.html pub trait Env { fn env_ptr(&self) -> *mut OCIEnv; fn err_ptr(&self) -> *mut OCIError; } impl Env for Environment { fn env_ptr(&self) -> *mut OCIEnv { self.env.get() } fn err_ptr(&self) -> *mut OCIError { self.err.get() } } impl Environment { pub(crate) fn new() -> Result<Self> { let env = create_environment()?; let err: Handle<OCIError> = Handle::new(env.get())?; Ok( Environment { env, err } ) } /// Returns the maximum size (high watermark) for the client-side object cache /// as a percentage of the optimal size. /// /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// let max_size_percentage = oracle.get_cache_max_size()?; /// /// assert_eq!(10, max_size_percentage); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn get_cache_max_size(&self) -> Result<u32> { self.env.get_attr::<u32>(OCI_ATTR_CACHE_MAX_SIZE, self.err_ptr()) } /// Sets the maximum size (high watermark) for the client-side object cache as a percentage /// of the optimal size. Usually you can set the value at 10%, the default, of the optimal size. /// Setting this attribute to 0 results in a value of 10 being used. The object cache uses the /// maximum and optimal values for freeing unused memory in the object cache. /// /// If the memory occupied by the objects currently in the cache reaches or exceeds the maximum /// cache size, the cache automatically begins to free (or ages out) unmarked objects that have /// a pin count of zero. The cache continues freeing such objects until memory usage in the cache /// reaches the optimal size, or until it runs out of objects eligible for freeing. Note that the /// cache can grow beyond the specified maximum cache size. /// /// The maximum object cache size (in bytes) is computed by incrementing `optimal_size` by the /// `max_size_percentage`, using the following algorithm: /// ```rust,ignore /// maximum_cache_size = optimal_size + optimal_size * max_size_percentage / 100 /// ``` /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// oracle.set_cache_max_size(30)?; /// let max_size_percentage = oracle.get_cache_max_size()?; /// /// assert_eq!(30, max_size_percentage); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn set_cache_max_size(&self, size: u32) -> Result<()> { self.env.set_attr(OCI_ATTR_CACHE_MAX_SIZE, size, self.err_ptr()) } /// Returns the optimal size for the client-side object cache in bytes. /// /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// let optimal_size = oracle.get_cache_opt_size()?; /// /// assert_eq!(8*1024*1024, optimal_size); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn get_cache_opt_size(&self) -> Result<u32> { self.env.get_attr::<u32>(OCI_ATTR_CACHE_OPT_SIZE, self.err_ptr()) } /// Sets the optimal size for the client-side object cache in bytes. The default value is 8 megabytes (MB). /// Setting this attribute to 0 results in a value of 8 MB being used. /// /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// oracle.set_cache_opt_size(64*1024*1024)?; /// let optimal_size = oracle.get_cache_opt_size()?; /// /// assert_eq!(64*1024*1024, optimal_size); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn set_cache_opt_size(&self, size: u32) -> Result<()> { self.env.set_attr(OCI_ATTR_CACHE_OPT_SIZE, size, self.err_ptr()) } /// Returns the name of the language used for the database sessions created in the current environment. /// /// See [Database Globalization Support Guide / Locale Data / Languages ][1] /// /// [1]: https://docs.oracle.com/en/database/oracle/oracle-database/19/nlspg/appendix-A-locale-data.html#GUID-D2FCFD55-EDC3-473F-9832-AAB564457830 /// /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// let lang = oracle.get_nls_language()?; /// /// assert_eq!("AMERICAN", lang); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn get_nls_language(&self) -> Result<String> { let mut lang = String::with_capacity(32); self.env.get_attr_into(OCI_ATTR_ENV_NLS_LANGUAGE, &mut lang, self.err_ptr())?; Ok( lang ) } /// Sets the language used for the database sessions created in the current environment. /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// oracle.set_nls_language("ENGLISH")?; /// let lang = oracle.get_nls_language()?; /// /// assert_eq!("ENGLISH", lang); /// # Ok::<(),Box<dyn std::error::Error>>(()) pub fn set_nls_language(&self, lang: &str) -> Result<()> { self.env.set_attr(OCI_ATTR_ENV_NLS_LANGUAGE, lang, self.err_ptr()) } /// Returns the name of the territory used for the database sessions created in the current environment. /// /// See [Database Globalization Support Guide / Locale Data / Territories ][1] /// /// [1]: https://docs.oracle.com/en/database/oracle/oracle-database/19/nlspg/appendix-A-locale-data.html#GUID-550D6A25-DB53-4911-9419-8065A73FFB06 /// /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// let lang = oracle.get_nls_territory()?; /// /// assert_eq!("AMERICA", lang); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn get_nls_territory(&self) -> Result<String> { let mut territory = String::with_capacity(24); self.env.get_attr_into(OCI_ATTR_ENV_NLS_TERRITORY, &mut territory, self.err_ptr())?; Ok( territory ) } /// Sets the name of the territory used for the database sessions created in the current environment. /// /// ## Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// oracle.set_nls_territory("CANADA")?; /// let lang = oracle.get_nls_territory()?; /// /// assert_eq!("CANADA", lang); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn set_nls_territory(&self, territory: &str) -> Result<()> { self.env.set_attr(OCI_ATTR_ENV_NLS_TERRITORY, territory, self.err_ptr()) } /// Creates and begins a user session for a given server. /// # Example /// ``` /// use sibyl as oracle; /// /// let oracle = oracle::env()?; /// let dbname = std::env::var("DBNAME")?; /// let dbuser = std::env::var("DBUSER")?; /// let dbpass = std::env::var("DBPASS")?; /// let conn = oracle.connect(&dbname, &dbuser, &dbpass)?; /// /// assert!(!conn.is_async()?); /// assert!(conn.is_connected()?); /// assert!(conn.ping().is_ok()); /// /// let stmt = conn.prepare(" /// SELECT DISTINCT client_driver /// FROM v$session_connect_info /// WHERE sid = SYS_CONTEXT('USERENV', 'SID') /// ")?; /// let rows = stmt.query(&[])?; /// let row = rows.next()?; /// assert!(row.is_some()); /// let row = row.unwrap(); /// let client_driver = row.get::<&str>(0)?; /// assert!(client_driver.is_some()); /// let client_driver = client_driver.unwrap(); /// assert_eq!(client_driver, "sibyl"); /// # Ok::<(),Box<dyn std::error::Error>>(()) /// ``` pub fn connect(&self, dbname: &str, username: &str, password: &str) -> Result<Connection> { let mut conn = Connection::new(self as &dyn Env)?; conn.attach(dbname)?; conn.login(username, password)?; Ok(conn) } }