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
//! # Persy - Transactional Persistence Engine //! //! Simple single file, durable, paginated, transactionan persistence engine, based on copy on write, write //! ahead log, two phase commit. //! //! # Example //! //! ```rust //! use persy::{Persy,Config}; //! //... //! # use persy::PRes; //! # fn foo() -> PRes<()> { //! Persy::create("./open.persy")?; //! let persy = Persy::open("./open.persy",Config::new())?; //! let mut tx = persy.begin()?; //! persy.create_segment(&mut tx, "seg")?; //! let data = vec![1;20]; //! persy.insert_record(&mut tx, "seg", &data)?; //! let prepared = persy.prepare_commit(tx)?; //! persy.commit(prepared)?; //! for rec in persy.scan_records("seg")? { //! assert_eq!(rec.content[0], 20); //! //.... //! } //! # Ok(()) //! # } //! ``` //! //! extern crate byteorder; extern crate fs2; mod allocator; mod address; mod transaction; mod discref; mod journal; mod config; mod segment; mod persy; mod record_scanner; /// Identifier of a persistent record, can be used for read, update or delete the record pub type PersyId = persy::RecRef; /// Transaction container, it include all the changes done in a transaction. pub type Transaction = transaction::Transaction; pub type TransactionId = Vec<u8>; use persy::PersyImpl; pub use record_scanner::IteratorItem; pub use record_scanner::RecordScanner; pub use record_scanner::RecordScannerTx; pub use persy::TransactionFinalize; use std::sync::Arc; pub use config::Config; pub use config::TxStrategy; pub use persy::PRes; pub use persy::PersyError; use std::fs::File; /// Main structure to manipolate persy storage files /// #[derive(Clone)] pub struct Persy { persy_impl: Arc<PersyImpl>, } impl Persy { /// Create a new database file. /// /// # Errors /// if the file already exist fail. /// pub fn create<P: Into<String>>(path: P) -> PRes<()> { PersyImpl::create(path) } /// Create a new database file. /// /// # Errors /// if the file already exist fail. /// pub fn create_from_file(file: File) -> PRes<()> { PersyImpl::create_from_file(file) } /// Open a database file. /// /// The file should have been created with [`Persy::create`] /// /// /// # Errors /// /// if the file does not exist fail. /// /// [`Persy::create`]: struct.Persy.html#method.create pub fn open<P: Into<String>>(path: P, config: Config) -> PRes<Persy> { Ok(Persy { persy_impl: Arc::new(PersyImpl::open(path, config)?), }) } /// Open a database file from a path with a recover function. /// /// The file should have been created with [`Persy::create`] /// /// /// # Errors /// /// if the file does not exist fail. /// /// [`Persy::create`]: struct.Persy.html#method.create pub fn open_with_recover<P: Into<String>, C>(path: P, config: Config, recover: C) -> PRes<Persy> where C: Fn(&TransactionId) -> bool, { Ok(Persy { persy_impl: Arc::new(PersyImpl::open_with_recover(path, config, recover)?), }) } /// Open a database file from a direct file handle. /// /// The file should have been created with [`Persy::create`] /// /// /// # Errors /// /// if the file does not exist fail. /// /// [`Persy::create`]: struct.Persy.html#method.create pub fn open_from_file(path: File, config: Config) -> PRes<Persy> { Ok(Persy { persy_impl: Arc::new(PersyImpl::open_from_file(path, config)?), }) } /// Open a database file, from a direct file handle and a transaction recover function. /// /// The file should have been created with [`Persy::create`] /// /// /// # Errors /// /// if the file does not exist fail. /// /// [`Persy::create`]: struct.Persy.html#method.create pub fn open_from_file_with_recover<C>(path: File, config: Config, recover: C) -> PRes<Persy> where C: Fn(&TransactionId) -> bool, { Ok(Persy { persy_impl: Arc::new(PersyImpl::open_from_file_with_recover( path, config, recover, )?), }) } /// Begin a new transaction. /// /// The transaction isolation level is 'read_commited'. /// for commit call [`prepare_commit`] and [`commit`] /// /// [`prepare_commit`]:struct.Persy.html#method.prepare_commit /// [`commit`]:struct.Persy.html#method.commit /// # Example /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// // ... /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn begin(&self) -> PRes<Transaction> { self.persy_impl.begin() } /// Begin a new transaction specifying and id usable for crash recover. /// /// The transaction isolation level is 'read_commited'. /// for commit call [`prepare_commit`] and [`commit`] /// /// [`prepare_commit`]:struct.Persy.html#method.prepare_commit /// [`commit`]:struct.Persy.html#method.commit /// # Example /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let tx_id = vec![2;2]; /// let mut tx = persy.begin_id(tx_id)?; /// // ... /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn begin_id(&self, meta_id: TransactionId) -> PRes<Transaction> { self.persy_impl.begin_id(meta_id) } /// Create a new segment with the provided name /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_segment(&mut tx, "my_new_segment")?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn create_segment(&self, tx: &mut Transaction, segment: &str) -> PRes<()> { self.persy_impl.create_segment(tx, segment) } /// Drop a existing segment /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.drop_segment(&mut tx, "existing_segment_name")?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` /// pub fn drop_segment(&self, tx: &mut Transaction, segment: &str) -> PRes<()> { self.persy_impl.drop_segment(tx, segment) } /// Check if a segment already exist in the storage /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_segment(&mut tx, "my_new_segment")?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// assert!(persy.exists_segment("my_new_segment")?); /// # Ok(()) /// # } /// ``` /// pub fn exists_segment(&self, segment: &str) -> PRes<bool> { self.persy_impl.exists_segment(segment) } /// Check if a segment already exist in the storage considering the transaction /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_segment(&mut tx, "my_new_segment")?; /// assert!(persy.exists_segment_tx(&mut tx, "my_new_segment")?); /// # let prepared = persy.prepare_commit(tx)?; /// # persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn exists_segment_tx(&self, tx: &Transaction, segment: &str) -> PRes<bool> { self.persy_impl.exists_segment_tx(tx, segment) } /// create a new record /// /// This function return an id that can be used by [`read_record`] and [`read_record_tx`], /// the record content can be read only with the [`read_record_tx`] till the transacion is commited. /// /// [`read_record_tx`]:struct.Persy.html#method.read_record_tx /// [`read_record`]:struct.Persy.html#method.read_record /// /// # Expample /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// persy.insert_record(&mut tx, "seg", &data)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn insert_record(&self, tx: &mut Transaction, segment: &str, rec: &Vec<u8>) -> PRes<PersyId> { self.persy_impl.insert_record(tx, segment, rec) } /// Read the record content considering eventual in transaction changes. /// /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// let id = persy.insert_record(&mut tx, "seg", &data)?; /// let read = persy.read_record_tx(&mut tx, "seg", &id)?.expect("record exists"); /// assert_eq!(data,read); /// # let prepared = persy.prepare_commit(tx)?; /// # persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn read_record_tx(&self, tx: &mut Transaction, segment: &str, id: &PersyId) -> PRes<Option<Vec<u8>>> { self.persy_impl.read_record_tx(tx, segment, id) } /// Read the record content from persistent data. /// /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// let id = persy.insert_record(&mut tx, "seg", &data)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// let read = persy.read_record("seg", &id)?.expect("record exits"); /// assert_eq!(data,read); /// # Ok(()) /// # } /// ``` pub fn read_record(&self, segment: &str, id: &PersyId) -> PRes<Option<Vec<u8>>> { self.persy_impl.read_record(segment, id) } /// Scan for persistent and in transaction records /// /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// let id = persy.insert_record(&mut tx, "seg", &data)?; /// let mut count = 0; /// for found in persy.scan_records_tx(&tx, "seg")? { /// println!("record size:{}",found.content.len()); /// count+=1; /// } /// assert_eq!(count,1); /// # Ok(()) /// # } /// ``` pub fn scan_records_tx<'a>(&'a self, tx: &'a Transaction, segment: &str) -> PRes<RecordScannerTx<'a>> { self.persy_impl.scan_records_tx(tx, segment) } /// Scan a segment for persistent records /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// let id = persy.insert_record(&mut tx, "seg", &data)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// let mut count = 0; /// for found in persy.scan_records("seg")? { /// println!("record size:{}",found.content.len()); /// count+=1; /// } /// assert_eq!(count,1); /// # Ok(()) /// # } /// ``` /// pub fn scan_records(&self, segment: &str) -> PRes<RecordScanner> { self.persy_impl.scan_records(segment) } /// update the record content. /// /// /// This updated content can be read only with the [`read_record_tx`] till the transacion is commited. /// /// [`read_record_tx`]:struct.Persy.html#method.read_record_tx /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// let id = persy.insert_record(&mut tx, "seg", &data)?; /// let new_data = vec![2;20]; /// persy.update_record(&mut tx, "seg", &id, &new_data)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn update_record(&self, tx: &mut Transaction, segment: &str, id: &PersyId, rec: &Vec<u8>) -> PRes<()> { self.persy_impl.update_record(tx, segment, id, rec) } /// delete a record. /// /// /// The record will result deleted only reading it whit [`read_record_tx`] till the transacion is commited. /// /// [`read_record_tx`]:struct.Persy.html#method.read_record_tx /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// let id = persy.insert_record(&mut tx, "seg", &data)?; /// persy.delete_record(&mut tx, "seg", &id)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn delete_record(&self, tx: &mut Transaction, segment: &str, id: &PersyId) -> PRes<()> { self.persy_impl.delete_record(tx, segment, id) } /// Rollback a not yet prepared transaction. /// /// All the resources used for eventual insert or update are released. /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// let data = vec![1;20]; /// persy.insert_record(&mut tx, "seg", &data)?; /// persy.rollback(tx)?; /// # Ok(()) /// # } /// ``` pub fn rollback(&self, tx: Transaction) -> PRes<()> { self.persy_impl.rollback(tx) } /// Prepare to commit a transaction, it will lock all the records involved in the transaction /// till a [`commit`] or [`rollback_prepared`] is called. /// /// [`commit`]:struct.Persy.html#method.commit /// [`rollback_prepared`]:struct.Persy.html#method.rollback_prepared /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_segment(&mut tx, "seg")?; /// //Do what ever operations on the records /// let data = vec![1;20]; /// persy.insert_record(&mut tx, "seg", &data)?; /// let _= persy.prepare_commit(tx)?; /// # Ok(()) /// # } /// ``` pub fn prepare_commit(&self, tx: Transaction) -> PRes<TransactionFinalize> { self.persy_impl.prepare_commit(tx) } /// Rollback a prepared commit. /// /// All the modification are rolled back and all the used resources are put released /// /// /// # Example /// /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// //Do what ever operations on the records /// let data = vec![1;20]; /// persy.insert_record(&mut tx, "seg", &data)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.rollback_prepared(prepared)?; /// # Ok(()) /// # } /// ``` /// pub fn rollback_prepared(&self, finalizer: TransactionFinalize) -> PRes<()> { self.persy_impl.rollback_prepared(finalizer) } /// Finalize the commit result of a prepared commit. /// /// All the operation done on the transaction are finalizated all the lock released, all the /// old resources are released for reuse. /// # Example /// ```rust /// # use persy::{Persy,Config,PRes}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared); /// # Ok(()) /// # } /// ``` /// pub fn commit(&self, finalizer: TransactionFinalize) -> PRes<()> { self.persy_impl.commit(finalizer) } }