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
use std::any::Any;
use crate::executor::{Executor, RBatisConnExecutor, RBatisTxExecutor};
use crate::table_sync::{sync, ColumnMapper};
use crate::{DefaultPool, Error};
use dark_std::sync::SyncVec;
use log::LevelFilter;
use rbdc::pool::ConnectionManager;
use rbdc::pool::Pool;
use rbs::value;
use serde::Serialize;
use std::fmt::Debug;
use std::ops::Deref;
use std::sync::{Arc, OnceLock};
use std::time::Duration;
use crate::intercept::Intercept;
use crate::intercept::intercept_log::LogInterceptor;
use crate::intercept::intercept_page::PageIntercept;
use crate::plugin::{IdGenerator, Snowflake};
/// RBatis engine
#[derive(Clone, Debug)]
pub struct RBatis {
// the connection pool
pub pool: Arc<OnceLock<Box<dyn Pool>>>,
// intercept vec(default the intercepts[0] is a log interceptor)
pub intercepts: Arc<SyncVec<Arc<dyn Intercept>>>,
//rb task id gen
pub task_id_generator: Arc<dyn IdGenerator>,
}
impl Default for RBatis {
fn default() -> RBatis {
RBatis {
pool: Arc::new(Default::default()),
intercepts: Arc::new(SyncVec::new()),
task_id_generator: Arc::new(Snowflake::default()),
}
}
}
impl RBatis {
/// create an RBatis
/// add intercept use LogInterceptor
pub fn new() -> Self {
let rb = RBatis::default();
//default use LogInterceptor
rb.intercepts.push(Arc::new(PageIntercept::new()));
rb.intercepts.push(Arc::new(LogInterceptor::new(LevelFilter::Debug)));
rb
}
/// self.init(driver, url)? and self.try_acquire().await? a connection.
/// DefaultPool use FastPool
pub async fn link<Driver: rbdc::db::Driver + 'static>(
&self,
driver: Driver,
url: &str,
) -> Result<(), Error> {
self.init(driver, url)?;
self.try_acquire().await?;
Ok(())
}
/// init pool.
/// The default connection pool only binds one type of database driver, please use separate RBatis for different database drivers
/// DefaultPool is FastPool,if you want other pool please use init_option
pub fn init<Driver: rbdc::db::Driver + 'static>(
&self,
driver: Driver,
url: &str,
) -> Result<(), Error> {
if url.is_empty() {
return Err(Error::from("[rb] link url is empty!"));
}
let mut option = driver.default_option();
option.set_uri(url)?;
// Directly construct ConnectionManager since new_options requires specific ConnectOptions type
let manager = ConnectionManager {
driver: std::sync::Arc::new(Box::new(driver)),
option: std::sync::Arc::new(option),
};
let pool = DefaultPool::new(manager)?;
self.pool
.set(Box::new(pool))
.map_err(|_e| Error::from("pool set fail!"))?;
Ok(())
}
/// init pool by DBPoolOptions and Pool
/// for example:
///```
/// use rbatis::{DefaultPool, RBatis};
/// use rbdc_sqlite::{SqliteConnectOptions, SqliteDriver};
/// let rb=RBatis::new();
///
/// let opts=SqliteConnectOptions::new();
/// let _ = rb.init_option::<SqliteDriver, SqliteConnectOptions, DefaultPool>(SqliteDriver{},opts);
/// ```
///
pub fn init_option<
Driver: rbdc::db::Driver + 'static,
ConnectOptions: rbdc::db::ConnectOptions,
Pool: rbdc::pool::Pool + 'static,
>(
&self,
driver: Driver,
option: ConnectOptions,
) -> Result<(), Error> {
let pool = Pool::new(ConnectionManager::new_options(driver, option))?;
self.pool
.set(Box::new(pool))
.map_err(|_e| Error::from("pool set fail!"))?;
Ok(())
}
pub fn init_pool<Pool: rbdc::pool::Pool + 'static>(&self, pool: Pool) -> Result<(), Error> {
self.pool
.set(Box::new(pool))
.map_err(|_e| Error::from("pool set fail!"))?;
Ok(())
}
/// set_intercepts for many.
/// notice:
/// do not forget add PageIntercept!
pub fn set_intercepts(&mut self, arg: Vec<Arc<dyn Intercept>>) {
self.intercepts = Arc::new(SyncVec::from(arg));
}
/// get conn pool
///
/// can set option for example:
/// ```rust
/// use rbatis::RBatis;
/// #[tokio::main]
/// async fn main(){
/// let rb = RBatis::new();
/// rb.init(rbdc_sqlite::driver::SqliteDriver{},"sqlite://target/sqlite.db").unwrap();
/// rb.get_pool().unwrap().set_max_open_conns(10).await;
/// }
/// ```
pub fn get_pool(&self) -> Result<&dyn Pool, Error> {
let p = self
.pool
.get()
.ok_or_else(|| Error::from("[rb] rbatis pool not inited!"))?;
Ok(p.deref())
}
/// get driver type
pub fn driver_type(&self) -> Result<&str, Error> {
let pool = self.get_pool()?;
Ok(pool.driver_type())
}
/// get an DataBase Connection used for the next step
pub async fn acquire(&self) -> Result<RBatisConnExecutor, Error> {
let pool = self.get_pool()?;
let conn = pool.get().await?;
Ok(RBatisConnExecutor::new(
self.task_id_generator.generate(),
conn,
self.clone(),
))
}
/// try get an DataBase Connection used for the next step
pub async fn try_acquire(&self) -> Result<RBatisConnExecutor, Error> {
self.try_acquire_timeout(Duration::from_secs(0)).await
}
/// try get an DataBase Connection used for the next step
pub async fn try_acquire_timeout(&self, d: Duration) -> Result<RBatisConnExecutor, Error> {
let pool = self.get_pool()?;
let conn = pool.get_timeout(d).await?;
Ok(RBatisConnExecutor::new(
self.task_id_generator.generate(),
conn,
self.clone(),
))
}
/// get an DataBase Connection,and call begin method,used for the next step
pub async fn acquire_begin(&self) -> Result<RBatisTxExecutor, Error> {
let conn = self.acquire().await?;
Ok(conn.begin().await?)
}
/// try get an DataBase Connection,and call begin method,used for the next step
pub async fn try_acquire_begin(&self) -> Result<RBatisTxExecutor, Error> {
let conn = self.try_acquire().await?;
let executor = conn.begin().await?;
Ok(executor)
}
/// is RBatis enable debug_mode?
pub fn is_debug_mode(&self) -> bool {
crate::decode::is_debug_mode()
}
/// get intercept from name
/// the default name just like `let name = std::any::type_name::<LogInterceptor>()`
/// ```rust
/// use std::sync::Arc;
/// use async_trait::async_trait;
/// use rbatis::RBatis;
/// use rbatis::intercept::{Intercept};
///
/// #[derive(Debug)]
/// pub struct MockIntercept {
/// }
/// #[async_trait]
/// impl Intercept for MockIntercept {
/// }
/// //use get_intercept_type
/// let mut rb = RBatis::new();
/// rb.set_intercepts(vec![Arc::new(MockIntercept{})]);
/// let name = std::any::type_name::<MockIntercept>();
/// let intercept = rb.get_intercept_dyn(name);
/// ```
pub fn get_intercept_dyn(&self, name: &str) -> Option<&dyn Intercept> {
for x in self.intercepts.iter() {
if name == x.name() {
return Some(x.as_ref());
}
}
None
}
/// get intercept from name
/// ```rust
/// use std::sync::Arc;
/// use async_trait::async_trait;
/// use rbatis::RBatis;
/// use rbatis::intercept::{Intercept};
///
/// #[derive(Debug)]
/// pub struct MockIntercept {
/// }
/// #[async_trait]
/// impl Intercept for MockIntercept {
/// }
/// //use get_intercept_type
/// let mut rb = RBatis::new();
/// rb.set_intercepts(vec![Arc::new(MockIntercept{})]);
/// let intercept = rb.get_intercept::<MockIntercept>();
/// ```
pub fn get_intercept<T: Intercept>(&self) -> Option<&T> {
let name = std::any::type_name::<T>();
for item in self.intercepts.iter() {
if name == item.name() {
let v: Option<&T> = <dyn Any>::downcast_ref::<T>(item.as_ref());
return v;
}
}
None
}
/// how to ge name
/// ```rust
/// pub struct Intercept{}
/// let name = std::any::type_name::<Intercept>();
/// ```
pub fn remove_intercept_dyn(&self, name: &str) -> Option<Arc<dyn Intercept>> {
let mut index = 0;
for item in self.intercepts.iter() {
if item.name() == name {
//this is safe
return self.intercepts.remove(index);
}
index += 1;
}
None
}
/// create table if not exists, add column if not exists
///
/// ```rust
/// use rbatis::executor::Executor;
/// use rbatis::RBatis;
/// use rbatis::table_sync::{SqliteTableMapper};
///
/// /// let rb = RBatis::new();
/// /// let conn = rb.acquire().await;
/// pub async fn do_sync_table(conn: &dyn Executor){
/// let map = rbs::value!{
/// "id":"INT",
/// "name":"TEXT",
/// };
/// let _ = RBatis::sync(conn,&SqliteTableMapper{},&map,"user").await;
/// }
/// ```
///
/// sync table struct
/// ```rust
/// use rbatis::executor::Executor;
/// use rbatis::RBatis;
/// use rbatis::table_sync::{SqliteTableMapper};
///
/// #[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
/// pub struct User{
/// pub id:String,
/// pub name: Option<String>
/// }
///
/// /// let rb = RBatis::new();
/// /// let conn = rb.acquire().await;
/// pub async fn do_sync_table(conn: &dyn Executor){
/// let table = User{id: "".to_string(), name: Some("".to_string())};
/// let _ = RBatis::sync(conn,&SqliteTableMapper{},&table,"user").await;
/// }
/// ```
///
/// sync table struct (custom string column type)
/// ```rust
/// use rbatis::executor::Executor;
/// use rbatis::RBatis;
/// use rbatis::table_sync::{MysqlTableMapper};
///
/// #[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
/// pub struct User{
/// pub id:String,
/// pub name: Option<String>
/// }
///
/// /// let rb = RBatis::new();
/// /// let conn = rb.acquire().await;
/// pub async fn do_sync_table_mysql(conn: &dyn Executor){
/// //empty string: auto create type, "VARCHAR(50)" -> sqlite type
/// let table = User{id: "".to_string(), name: Some("VARCHAR(50)".to_string())};
/// let _ = RBatis::sync(conn,&MysqlTableMapper{},&table,"user").await;
/// }
/// ```
pub async fn sync<T: Serialize>(
executor: &dyn Executor,
column_mapper: &dyn ColumnMapper,
table: &T,
table_name: &str,
) -> Result<(), Error> {
sync(executor, column_mapper, value!(table), table_name).await
}
}