sibyl 0.7.0

An OCI-based (synchronous or asynchronous) interface between Rust applications and Oracle databases
Documentation 
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

//! Nonblocking mode database session methods.

use std::{sync::{Arc, atomic::{AtomicUsize, Ordering}}, marker::PhantomData};

use parking_lot::RwLock;

use crate::{oci::{self, *}, pool::SessionPool, session::SessionTagInfo, task, Environment, Result, Statement};

use super::{SvcCtx, Session};

impl SvcCtx {
    async fn new(env: &Environment, dblink: &str, user: &str, pass: &str, mode: u32) -> Result<Self> {
        let err = Handle::<OCIError>::new(&env)?;
        let inf = Handle::<OCIAuthInfo>::new(&env)?;
        inf.set_attr(OCI_ATTR_DRIVER_NAME, "sibyl", &err)?;
        inf.set_attr(OCI_ATTR_USERNAME, user, &err)?;
        inf.set_attr(OCI_ATTR_PASSWORD, pass, &err)?;

        let env = env.get_env();
        let dblink = String::from(dblink);
        task::execute_blocking(move || -> Result<Self> {
            let mut svc = Ptr::<OCISvcCtx>::null();
            oci::session_get(
                env.as_ref(), err.as_ref(), svc.as_mut_ptr(), inf.as_ref(),
                dblink.as_ptr(), dblink.len() as _,
                mode | OCI_SESSGET_STMTCACHE
            )?;
            Ok(Self { svc, inf, err, env, spool: None, tag: None, active_future: AtomicUsize::new(0) })
        }).await?
    }

    fn set_oci_nonblocking_mode(&self, mode: u8) -> Result<()> {
        let srv: Ptr<OCIServer> = attr::get(OCI_ATTR_SERVER, OCI_HTYPE_SVCCTX, self.svc.as_ref(), self.err.as_ref())?;
        let curr_mode : u8 = attr::get(OCI_ATTR_NONBLOCKING_MODE, OCI_HTYPE_SERVER, srv.as_ref(), self.as_ref())?;
        if curr_mode != mode {
            attr::set(OCI_ATTR_NONBLOCKING_MODE, mode, OCI_HTYPE_SERVER, srv.as_ref(), self.as_ref())
        } else {
            Ok(())
        }
    }

    pub(crate) fn set_nonblocking_mode(&self) -> Result<()> {
        self.set_oci_nonblocking_mode(1)
    }

    pub(crate) fn set_blocking_mode(&self) -> Result<()> {
        self.set_oci_nonblocking_mode(0)
    }

    async fn from_session_pool<'a>(pool: &'a SessionPool<'a>, tag: &str) -> Result<(Self,bool)> {
        let spool = pool.get_spool();
        let env = spool.get_env();
        let err = Handle::<OCIError>::new(env.as_ref())?;
        let inf = Handle::<OCIAuthInfo>::new(env.as_ref())?;
        let tag_len = tag.len() as u32;
        let tag_ptr = Ptr::new(tag.as_ptr());
        let tag_mode = if tag_len > 0 && tag.find('=').is_some() { OCI_SESSGET_MULTIPROPERTY_TAG } else { OCI_DEFAULT };

        task::execute_blocking(move || -> Result<(Self,bool)> {
            let name = spool.get_name();
            let mut svc = Ptr::<OCISvcCtx>::null();
            let mut found = oci::Aligned::new(0u8);
            let mut ret_tag: *const u8 = std::ptr::null();
            let mut ret_tag_len: u32 = 0;
            oci::session_get_tagged(
                env.as_ref(), err.as_ref(), svc.as_mut_ptr(), inf.as_ref(),
                name.as_ptr(), name.len() as _,
                tag_ptr.get(), tag_len, &mut ret_tag, &mut ret_tag_len,
                found.as_mut_ptr(), tag_mode | OCI_SESSGET_SPOOL | OCI_SESSGET_PURITY_SELF
            )?;
            let found = <u8>::from(found) != 0;
            let svc_ctx = Self {svc, inf, err, env,
                spool: Some(spool),
                tag: Some(RwLock::new(SessionTagInfo {
                    tag_ptr: Ptr::new(ret_tag),
                    tag_len: ret_tag_len as _,
                    new_tag: String::new(),
                })),
                active_future: AtomicUsize::new(0)
            };
            Ok((svc_ctx, found))
        }).await?
    }

    pub(crate) fn lock(&self, id: usize) -> bool {
        if let Err(current) = self.active_future.compare_exchange(0, id, Ordering::AcqRel, Ordering::Relaxed) {
            current == id
        } else {
            true
        }
    }

    pub(crate) fn unlock(&self) {
        self.active_future.store(0, Ordering::Release)
    }
}

impl<'a> Session<'a> {
    pub(crate) async fn new(env: &Environment, dblink: &str, user: &str, pass: &str, mode: u32) -> Result<Self> {
        let ctx = SvcCtx::new(env, dblink, user, pass, mode).await?;
        ctx.set_nonblocking_mode()?;
        let usr: Ptr<OCISession> = attr::get(OCI_ATTR_SESSION, OCI_HTYPE_SVCCTX, ctx.svc.as_ref(), ctx.as_ref())?;
        let ctx = Arc::new(ctx);
        Ok(Self { ctx, usr, phantom_env: PhantomData })
    }

    pub(crate) async fn from_session_pool(pool: &SessionPool<'_>, tag: &str) -> Result<(Self,bool)> {
        let (ctx, found) = SvcCtx::from_session_pool(pool, tag).await?;
        ctx.set_nonblocking_mode()?;
        let usr: Ptr<OCISession> = attr::get(OCI_ATTR_SESSION, OCI_HTYPE_SVCCTX, ctx.svc.as_ref(), ctx.as_ref())?;
        let ctx = Arc::new(ctx);
        Ok((Self {ctx, usr, phantom_env: PhantomData}, found))
    }

    pub(crate) fn set_nonblocking_mode(&self) -> Result<()> {
        self.ctx.set_nonblocking_mode()
    }

    pub(crate) fn set_blocking_mode(&self) -> Result<()> {
        self.ctx.set_blocking_mode()
    }

    /**
    Confirms that the connection and the server are active.

    # Example

    ```
    # sibyl::block_on(async {
    # let session = sibyl::test_env::get_session().await?;
    # session.start_call_time_measurements()?;
    session.ping().await?;
    # let dt = session.call_time()?;
    # session.stop_call_time_measurements()?;
    # assert!(dt > 0);
    # Ok::<(),sibyl::Error>(()) }).expect("Ok from async");
    ```
    */
    pub async fn ping(&self) -> Result<()> {
        futures::Ping::new(self.get_svc()).await
    }

    /**
    Commits the current transaction.

    Current transaction is defined as the set of statements executed since
    the last commit or since the beginning of the user session.

    # Example

    ```
    # sibyl::block_on(async {
    # let session = sibyl::test_env::get_session().await?;
    let stmt = session.prepare("
        UPDATE hr.employees
           SET salary = :new_salary
         WHERE employee_id = :emp_id
    ").await?;
    let num_updated_rows = stmt.execute((
        (":EMP_ID",     107 ),
        (":NEW_SALARY", 4200),
    )).await?;
    assert_eq!(num_updated_rows, 1);

    session.commit().await?;
    # Ok::<(),sibyl::Error>(()) }).expect("Ok from async");
    ```
    */
    pub async fn commit(&self) -> Result<()> {
        futures::TransCommit::new(self.get_svc()).await
    }

    /**
    Rolls back the current transaction. The modified or updated objects in
    the object cache for this transaction are also rolled back.

    # Example

    ```
    # sibyl::block_on(async {
    # let session = sibyl::test_env::get_session().await?;
    let stmt = session.prepare("
        UPDATE hr.employees
           SET salary = ROUND(salary * 1.1)
         WHERE employee_id = :emp_id
    ").await?;
    let num_updated_rows = stmt.execute(107).await?;
    assert_eq!(num_updated_rows, 1);

    session.rollback().await?;
    # Ok::<(),sibyl::Error>(()) }).expect("Ok from async");
    ```
    */
    pub async fn rollback(&self) -> Result<()> {
        futures::TransRollback::new(self.get_svc()).await
    }

    /**
    Prepares SQL or PL/SQL statement for execution.

    # Parameters

    * `sql` - SQL or PL/SQL statement

    # Example

    ```
    # sibyl::block_on(async {
    # let session = sibyl::test_env::get_session().await?;
    let stmt = session.prepare("
        SELECT employee_id
          FROM (
                SELECT employee_id
                     , row_number() OVER (ORDER BY hire_date) AS hire_date_rank
                  FROM hr.employees
               )
         WHERE hire_date_rank = 1
    ").await?;
    let row = stmt.query_single(()).await?.unwrap();
    let id : u32 = row.get(0)?;
    assert_eq!(id, 102);
    # Ok::<(),sibyl::Error>(()) }).expect("Ok from async");
    ```
    */
    pub async fn prepare(&'a self, sql: &str) -> Result<Statement<'a>> {
        Statement::new(sql, self).await
    }
}

#[cfg(test)]
mod tests {
    use crate::{Environment, Result};

    #[test]
    fn async_connect_static_env() -> Result<()> {
        crate::block_on(async {
            use std::env;
            use once_cell::sync::OnceCell;

            static ORACLE : OnceCell<Environment> = OnceCell::new();
            let oracle = ORACLE.get_or_try_init(|| {
                Environment::new()
            })?;

            let dbname = env::var("DBNAME").expect("database name");
            let dbuser = env::var("DBUSER").expect("user name");
            let dbpass = env::var("DBPASS").expect("password");

            let session = oracle.connect(&dbname, &dbuser, &dbpass).await?;
            session.ping().await?;

            Ok(())
        })
    }
}