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 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
//! # Persy - Transactional Persistence Engine //! //! Simple single file, durable, paginated, transactional 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 (_id,content) in persy.scan("seg")? { //! assert_eq!(content[0], 20); //! //.... //! } //! # Ok(()) //! # } //! ``` //! //! extern crate byteorder; extern crate crc; extern crate data_encoding; extern crate fs2; extern crate unsigned_varint; mod address; mod allocator; mod config; mod discref; mod flush_checksum; mod index; mod journal; mod persy; mod record_scanner; mod segment; mod snapshot; mod transaction; pub use config::{Config, TxStrategy}; pub use index::config::ValueMode; pub use index::config::{IndexType, IndexTypeId}; use index::keeper::IndexRawIter; pub use index::keeper::TxIndexIter; pub use index::tree::Value; pub use persy::IndexInfo; pub use persy::{PRes, PersyError}; use persy::{PersyImpl, TxFinalize}; #[allow(deprecated)] pub use record_scanner::{IteratorItem, RecordScanner, RecordScannerTx}; use record_scanner::{SegmentRawIter, TxSegmentRawIter}; use std::fmt; use std::fs::File; use std::ops::RangeBounds; use std::sync::Arc; /// Identifier of a persistent record, can be used for read, update or delete the record #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug)] pub struct PersyId(persy::RecRef); impl fmt::Display for PersyId { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.0) } } impl std::str::FromStr for PersyId { type Err = PersyError; fn from_str(s: &str) -> Result<Self, Self::Err> { Ok(PersyId(s.parse()?)) } } /// Transaction container, it include all the changes done in a transaction. pub struct Transaction(transaction::Transaction); /// Unique identifier of an index #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug)] pub struct IndexId(u32); /// Unique identifier of a segment #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug)] pub struct SegmentId(u32); pub type TransactionId = Vec<u8>; /// Main structure to operate persy storage files /// #[derive(Clone)] pub struct Persy { persy_impl: Arc<PersyImpl>, } /// prepared transaction state #[must_use] pub struct TransactionFinalize { persy_impl: Arc<PersyImpl>, pub finalize: TxFinalize, } impl Drop for TransactionFinalize { fn drop(&mut self) { self.persy_impl.rollback_prepared(&mut self.finalize).unwrap(); } } /// Index Iterator implementation for iterating on a range of keys pub struct IndexIter<K: IndexType, V: IndexType> { iter_impl: IndexRawIter<K, V>, persy_impl: Arc<PersyImpl>, } impl<K: IndexType, V: IndexType> IndexIter<K, V> { fn new(iter_impl: IndexRawIter<K, V>, persy_impl: Arc<PersyImpl>) -> IndexIter<K, V> { IndexIter { iter_impl, persy_impl } } } impl<K, V> Iterator for IndexIter<K, V> where K: IndexType, V: IndexType, { type Item = (K, Value<V>); fn next(&mut self) -> Option<Self::Item> { self.iter_impl.next(&self.persy_impl) } } impl<K, V> Drop for IndexIter<K, V> where K: IndexType, V: IndexType, { fn drop(&mut self) { self.iter_impl.release(&self.persy_impl).unwrap() } } /// Iterator implementation to scan a segment pub struct SegmentIter { iter_impl: SegmentRawIter, persy_impl: Arc<PersyImpl>, } impl SegmentIter { fn new(iter_impl: SegmentRawIter, persy_impl: Arc<PersyImpl>) -> SegmentIter { SegmentIter { iter_impl, persy_impl } } } impl Iterator for SegmentIter { type Item = (PersyId, Vec<u8>); fn next(&mut self) -> Option<Self::Item> { self.iter_impl.next(&self.persy_impl) } } /// Iterator implementation to scan a segment considering in transaction changes. pub struct TxSegmentIter<'a> { iter_impl: TxSegmentRawIter<'a>, persy_impl: Arc<PersyImpl>, } impl<'a> TxSegmentIter<'a> { fn new(iter_impl: TxSegmentRawIter<'a>, persy_impl: Arc<PersyImpl>) -> TxSegmentIter<'a> { TxSegmentIter { iter_impl, persy_impl } } } impl<'a> Iterator for TxSegmentIter<'a> { type Item = (PersyId, Vec<u8>); fn next(&mut self) -> Option<Self::Item> { self.iter_impl.next(&self.persy_impl) } } 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> { Ok(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> { Ok(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<()> { assert!(!segment.starts_with(index::config::INDEX_META_PREFIX)); assert!(!segment.starts_with(index::config::INDEX_DATA_PREFIX)); self.persy_impl.create_segment(&mut tx.0, 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(&mut tx.0, 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.0, 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 transaction is committed. /// /// [`read_record_tx`]:struct.Persy.html#method.read_record_tx /// [`read_record`]:struct.Persy.html#method.read_record /// /// # 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)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn insert_record(&self, tx: &mut Transaction, segment: &str, rec: &[u8]) -> PRes<PersyId> { Ok(PersyId(self.persy_impl.insert_record(&mut tx.0, 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(&mut tx.0, segment, &id.0) } /// 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.0) } /// 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(()) /// # } /// ``` #[deprecated(since = "0.5.0", note = "please use `scan_tx` instead")] #[allow(deprecated)] pub fn scan_records_tx<'a>(&'a self, tx: &'a Transaction, segment: &str) -> PRes<RecordScannerTx<'a>> { Ok(RecordScannerTx::new(self.scan_tx(tx, segment)?)) } /// 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 (id,content) in persy.scan_tx(&tx, "seg")? { /// println!("record size:{}",content.len()); /// count+=1; /// } /// assert_eq!(count,1); /// # Ok(()) /// # } /// ``` pub fn scan_tx<'a>(&'a self, tx: &'a Transaction, segment: &str) -> PRes<TxSegmentIter<'a>> { Ok(TxSegmentIter::new( self.persy_impl.scan_tx(&tx.0, segment)?, self.persy_impl.clone(), )) } /// 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(()) /// # } /// ``` /// #[deprecated(since = "0.5.0", note = "please use `scan` instead")] #[allow(deprecated)] pub fn scan_records(&self, segment: &str) -> PRes<RecordScanner> { Ok(RecordScanner::new(self.scan(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 (id,content) in persy.scan("seg")? { /// println!("record size:{}",content.len()); /// count+=1; /// } /// assert_eq!(count,1); /// # Ok(()) /// # } /// ``` /// pub fn scan(&self, segment: &str) -> PRes<SegmentIter> { Ok(SegmentIter::new( self.persy_impl.scan(segment)?, self.persy_impl.clone(), )) } /// update the record content. /// /// /// This updated content can be read only with the [`read_record_tx`] till the transaction is committed. /// /// [`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: &[u8]) -> PRes<()> { self.persy_impl.update_record(&mut tx.0, segment, &id.0, rec) } /// delete a record. /// /// /// The record will result deleted only reading it whit [`read_record_tx`] till the transaction is committed. /// /// [`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(&mut tx.0, segment, &id.0) } /// Create a new index with the name and the value management mode. /// /// The create operation require two template arguments that are the types as keys and /// values of the index this have to match the following operation on the indexes. /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// # let persy = Persy::open("./data.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::CLUSTER)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn create_index<K, V>(&self, tx: &mut Transaction, index_name: &str, value_mode: ValueMode) -> PRes<()> where K: IndexType, V: IndexType, { self.persy_impl.create_index::<K, V>(&mut tx.0, index_name, value_mode) } /// Drop an existing index. /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// # let persy = Persy::open("./data.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.drop_index(&mut tx, "my_new_index")?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn drop_index(&self, tx: &mut Transaction, index_name: &str) -> PRes<()> { self.persy_impl.drop_index(&mut tx.0, index_name) } /// Check if a segment already exist in the storage /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::REPLACE)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// assert!(persy.exists_index("my_new_index")?); /// # Ok(()) /// # } /// ``` /// pub fn exists_index(&self, segment: &str) -> PRes<bool> { self.persy_impl.exists_index(segment) } /// Check if a segment already exist in the storage considering the transaction /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::REPLACE)?; /// assert!(persy.exists_index_tx(&mut tx, "my_new_index")?); /// # let prepared = persy.prepare_commit(tx)?; /// # persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn exists_index_tx(&self, tx: &Transaction, segment: &str) -> PRes<bool> { self.persy_impl.exists_index_tx(&tx.0, segment) } /// Put a key value in an index following the value mode strategy. /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// # let persy = Persy::open("./data.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::CLUSTER)?; /// persy.put::<u8,u8>(&mut tx, "my_new_index",10,10)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn put<K, V>(&self, tx: &mut Transaction, index_name: &str, k: K, v: V) -> PRes<()> where K: IndexType, V: IndexType, { self.persy_impl.put::<K, V>(&mut tx.0, index_name, k, v) } /// Remove a key and optionally a specific value from an index following the value mode strategy. /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// # let persy = Persy::open("./data.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::CLUSTER)?; /// persy.put::<u8,u8>(&mut tx, "my_new_index",10,10)?; /// persy.remove::<u8,u8>(&mut tx, "my_new_index",10,Some(10))?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn remove<K, V>(&self, tx: &mut Transaction, index_name: &str, k: K, v: Option<V>) -> PRes<()> where K: IndexType, V: IndexType, { self.persy_impl.remove::<K, V>(&mut tx.0, index_name, k, v) } /// Get a value or a group of values from a key. /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode, Value}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// # let persy = Persy::open("./data.persy",Config::new())?; /// # let mut tx = persy.begin()?; /// # persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::CLUSTER)?; /// # persy.put::<u8,u8>(&mut tx, "my_new_index",10,10)?; /// # let prepared = persy.prepare_commit(tx)?; /// # persy.commit(prepared)?; /// let val = persy.get::<u8,u8>("my_new_index",&10)?; /// if let Some(is_there) = val { /// // A value is actually there /// match is_there { /// Value::SINGLE(actual_value) => { /// }, /// Value::CLUSTER(actual_value) => { /// }, /// } /// } /// # Ok(()) /// # } /// ``` pub fn get<K, V>(&self, index_name: &str, k: &K) -> PRes<Option<Value<V>>> where K: IndexType, V: IndexType, { self.persy_impl.get::<K, V>(index_name, k) } /// Get a value or a group of values from a key considering changes in transaction. /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode, Value}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// # let persy = Persy::open("./data.persy",Config::new())?; /// # let mut tx = persy.begin()?; /// # persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::CLUSTER)?; /// persy.put::<u8,u8>(&mut tx, "my_new_index",10,10)?; /// let val = persy.get_tx::<u8,u8>(&mut tx,"my_new_index",&10)?; /// if let Some(is_there) = val { /// // A value is actually there /// match is_there { /// Value::SINGLE(actual_value) => { /// }, /// Value::CLUSTER(actual_value) => { /// }, /// } /// } /// # let prepared = persy.prepare_commit(tx)?; /// # persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn get_tx<K, V>(&self, tx: &mut Transaction, index_name: &str, k: &K) -> PRes<Option<Value<V>>> where K: IndexType, V: IndexType, { self.persy_impl.get_tx::<K, V>(&mut tx.0, index_name, k) } /// Browse a range of keys and values from and index. /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode, Value,IndexIter}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// # let persy = Persy::open("./data.persy",Config::new())?; /// # let mut tx = persy.begin()?; /// # persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::CLUSTER)?; /// # persy.put::<u8,u8>(&mut tx, "my_new_index",10,10)?; /// # let prepared = persy.prepare_commit(tx)?; /// # persy.commit(prepared)?; /// let iter:IndexIter<u8,u8> = persy.range("my_new_index",10..12)?; /// for (k,val) in iter { /// // A value is actually there /// match val { /// Value::SINGLE(actual_value) => { /// }, /// Value::CLUSTER(actual_value) => { /// }, /// } /// } /// # Ok(()) /// # } /// ``` pub fn range<K, V, R>(&self, index_name: &str, range: R) -> PRes<IndexIter<K, V>> where K: IndexType, V: IndexType, R: RangeBounds<K>, { let (_, raw) = self.persy_impl.range(index_name, range)?; Ok(IndexIter::new(raw, self.persy_impl.clone())) } /// Browse a range of keys and values from and index including the transaction changes /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode, Value,TxIndexIter}; /// # fn foo() -> PRes<()> { /// # Persy::create("./data.persy")?; /// let persy = Persy::open("./data.persy",Config::new())?; /// let mut tx = persy.begin()?; /// # persy.create_index::<u8,u8>(&mut tx, "my_new_index", ValueMode::CLUSTER)?; /// persy.put::<u8,u8>(&mut tx, "my_new_index",10,10)?; /// { /// let iter:TxIndexIter<u8,u8> = persy.range_tx(&tx,"my_new_index",10..12)?; /// for (k,val) in iter { /// // A value is actually there /// match val { /// Value::SINGLE(actual_value) => { /// }, /// Value::CLUSTER(actual_value) => { /// }, /// } /// } /// } /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn range_tx<'a, K, V, R>(&self, tx: &'a Transaction, index_name: &str, range: R) -> PRes<TxIndexIter<'a, K, V>> where K: IndexType, V: IndexType, R: RangeBounds<K> + Clone, { let (vm, raw) = self.persy_impl.range(index_name, range.clone())?; let iter = IndexIter::new(raw, self.persy_impl.clone()); let tx_iter = tx.0.index_range::<K, V, R>(index_name, range); Ok(TxIndexIter::new(index_name, tx_iter, Some(iter), &tx.0, vm)) } /// 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.0) } /// 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> { Ok(TransactionFinalize { persy_impl: self.persy_impl.clone(), finalize: self.persy_impl.prepare_commit(tx.0)?, }) } /// 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, mut finalizer: TransactionFinalize) -> PRes<()> { self.persy_impl.rollback_prepared(&mut finalizer.finalize)?; Ok(()) } /// Finalize the commit result of a prepared commit. /// /// All the operation done on the transaction are finalized 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, mut finalizer: TransactionFinalize) -> PRes<()> { self.persy_impl.commit(&mut finalizer.finalize)?; Ok(()) } /// List all the existing segments. /// /// /// # 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 prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// let segments = persy.list_segments()?; /// let names = segments.into_iter().map(|(name,_id)|name).collect::<Vec<String>>(); /// assert!(names.contains(&"seg".to_string())); /// # Ok(()) /// # } /// ``` pub fn list_segments(&self) -> PRes<Vec<(String, SegmentId)>> { Ok(self .persy_impl .list_segments()? .into_iter() .map(|(name, id)| (name, SegmentId(id))) .collect()) } /// List all the existing segments. /// /// /// # 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 prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// let segments = persy.list_segments()?; /// let names = segments.into_iter().map(|(name,_id)|name).collect::<Vec<String>>(); /// assert!(names.contains(&"seg".to_string())); /// # Ok(()) /// # } /// ``` pub fn list_indexes(&self) -> PRes<Vec<(String, IndexInfo)>> { Ok(self.persy_impl.list_indexes()?) } /// List all the existing indexes. /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_index::<u8, u8>(&mut tx, "idx", ValueMode::REPLACE)?; /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// let indexes = persy.list_indexes()?; /// let names = indexes.into_iter().map(|(name,_id)|name).collect::<Vec<String>>(); /// assert!(names.contains(&"idx".to_string())); /// # Ok(()) /// # } /// ``` pub fn list_segments_tx(&self, tx: &Transaction) -> PRes<Vec<(String, SegmentId)>> { Ok(self .persy_impl .list_segments_tx(&tx.0)? .into_iter() .map(|(name, id)| (name, SegmentId(id))) .collect()) } /// List all the existing indexes, considering changes in the transaction. /// /// /// # Example /// ```rust /// # use persy::{Persy,Config,PRes,ValueMode}; /// # fn foo() -> PRes<()> { /// # Persy::create("./open.persy")?; /// # let persy = Persy::open("./open.persy",Config::new())?; /// let mut tx = persy.begin()?; /// persy.create_index::<u8, u8>(&mut tx, "idx", ValueMode::REPLACE)?; /// let indexes = persy.list_indexes_tx(&tx)?; /// let names = indexes.into_iter().map(|(name,_id)|name).collect::<Vec<String>>(); /// assert!(names.contains(&"idx".to_string())); /// let prepared = persy.prepare_commit(tx)?; /// persy.commit(prepared)?; /// # Ok(()) /// # } /// ``` pub fn list_indexes_tx(&self, tx: &Transaction) -> PRes<Vec<(String, IndexInfo)>> { Ok(self.persy_impl.list_indexes_tx(&tx.0)?) } }