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
// Copyright 2021 Yiyuan Liu
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
use std::{marker::PhantomData, ptr};
use crate::{
db::{convert_values, DBAccess},
ffi, AsColumnFamilyRef, DBIteratorWithThreadMode, DBPinnableSlice, DBRawIteratorWithThreadMode,
Direction, Error, IteratorMode, ReadOptions, SnapshotWithThreadMode, WriteBatchWithTransaction,
};
use libc::{c_char, c_void, size_t};
/// RocksDB Transaction.
///
/// To use transactions, you must first create a [`TransactionDB`] or [`OptimisticTransactionDB`].
///
/// [`TransactionDB`]: crate::TransactionDB
/// [`OptimisticTransactionDB`]: crate::OptimisticTransactionDB
pub struct Transaction<'db, DB> {
pub(crate) inner: *mut ffi::rocksdb_transaction_t,
pub(crate) _marker: PhantomData<&'db DB>,
}
unsafe impl<'db, DB> Send for Transaction<'db, DB> {}
impl<'db, DB> DBAccess for Transaction<'db, DB> {
unsafe fn create_snapshot(&self) -> *const ffi::rocksdb_snapshot_t {
ffi::rocksdb_transaction_get_snapshot(self.inner)
}
unsafe fn release_snapshot(&self, snapshot: *const ffi::rocksdb_snapshot_t) {
ffi::rocksdb_free(snapshot as *mut c_void);
}
unsafe fn create_iterator(&self, readopts: &ReadOptions) -> *mut ffi::rocksdb_iterator_t {
ffi::rocksdb_transaction_create_iterator(self.inner, readopts.inner)
}
unsafe fn create_iterator_cf(
&self,
cf_handle: *mut ffi::rocksdb_column_family_handle_t,
readopts: &ReadOptions,
) -> *mut ffi::rocksdb_iterator_t {
ffi::rocksdb_transaction_create_iterator_cf(self.inner, readopts.inner, cf_handle)
}
fn get_opt<K: AsRef<[u8]>>(
&self,
key: K,
readopts: &ReadOptions,
) -> Result<Option<Vec<u8>>, Error> {
self.get_opt(key, readopts)
}
fn get_cf_opt<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
readopts: &ReadOptions,
) -> Result<Option<Vec<u8>>, Error> {
self.get_cf_opt(cf, key, readopts)
}
fn get_pinned_opt<K: AsRef<[u8]>>(
&self,
key: K,
readopts: &ReadOptions,
) -> Result<Option<DBPinnableSlice>, Error> {
self.get_pinned_opt(key, readopts)
}
fn get_pinned_cf_opt<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
readopts: &ReadOptions,
) -> Result<Option<DBPinnableSlice>, Error> {
self.get_pinned_cf_opt(cf, key, readopts)
}
fn multi_get_opt<K, I>(
&self,
keys: I,
readopts: &ReadOptions,
) -> Vec<Result<Option<Vec<u8>>, Error>>
where
K: AsRef<[u8]>,
I: IntoIterator<Item = K>,
{
self.multi_get_opt(keys, readopts)
}
fn multi_get_cf_opt<'b, K, I, W>(
&self,
keys_cf: I,
readopts: &ReadOptions,
) -> Vec<Result<Option<Vec<u8>>, Error>>
where
K: AsRef<[u8]>,
I: IntoIterator<Item = (&'b W, K)>,
W: AsColumnFamilyRef + 'b,
{
self.multi_get_cf_opt(keys_cf, readopts)
}
}
impl<'db, DB> Transaction<'db, DB> {
/// Write all batched keys to the DB atomically.
///
/// May return any error that could be returned by `DB::write`.
///
/// If this transaction was created by a [`TransactionDB`], an error of
/// the [`Expired`] kind may be returned if this transaction has
/// lived longer than expiration time in [`TransactionOptions`].
///
/// If this transaction was created by an [`OptimisticTransactionDB`], an error of
/// the [`Busy`] kind may be returned if the transaction
/// could not guarantee that there are no write conflicts.
/// An error of the [`TryAgain`] kind may be returned if the memtable
/// history size is not large enough (see [`Options::set_max_write_buffer_size_to_maintain`]).
///
/// [`Expired`]: crate::ErrorKind::Expired
/// [`TransactionOptions`]: crate::TransactionOptions
/// [`TransactionDB`]: crate::TransactionDB
/// [`OptimisticTransactionDB`]: crate::OptimisticTransactionDB
/// [`Busy`]: crate::ErrorKind::Busy
/// [`TryAgain`]: crate::ErrorKind::TryAgain
/// [`Options::set_max_write_buffer_size_to_maintain`]: crate::Options::set_max_write_buffer_size_to_maintain
pub fn commit(self) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_commit(self.inner));
}
Ok(())
}
pub fn set_name(&self, name: &[u8]) -> Result<(), Error> {
let ptr = name.as_ptr();
let len = name.len();
unsafe {
ffi_try!(ffi::rocksdb_transaction_set_name(
self.inner, ptr as _, len as _
));
}
Ok(())
}
pub fn get_name(&self) -> Option<Vec<u8>> {
unsafe {
let mut name_len = 0;
let name = ffi::rocksdb_transaction_get_name(self.inner, &mut name_len);
if name.is_null() {
None
} else {
let mut vec = vec![0; name_len];
std::ptr::copy_nonoverlapping(name as *mut u8, vec.as_mut_ptr(), name_len);
ffi::rocksdb_free(name as *mut c_void);
Some(vec)
}
}
}
pub fn prepare(&self) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_prepare(self.inner));
}
Ok(())
}
/// Returns snapshot associated with transaction if snapshot was enabled in [`TransactionOptions`].
/// Otherwise, returns a snapshot with `nullptr` inside which doesn't effect read operations.
///
/// [`TransactionOptions`]: crate::TransactionOptions
pub fn snapshot(&self) -> SnapshotWithThreadMode<Self> {
SnapshotWithThreadMode::new(self)
}
/// Discard all batched writes in this transaction.
pub fn rollback(&self) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_rollback(self.inner));
Ok(())
}
}
/// Record the state of the transaction for future calls to [`rollback_to_savepoint`].
/// May be called multiple times to set multiple save points.
///
/// [`rollback_to_savepoint`]: Self::rollback_to_savepoint
pub fn set_savepoint(&self) {
unsafe {
ffi::rocksdb_transaction_set_savepoint(self.inner);
}
}
/// Undo all operations in this transaction since the most recent call to [`set_savepoint`]
/// and removes the most recent [`set_savepoint`].
///
/// Returns error if there is no previous call to [`set_savepoint`].
///
/// [`set_savepoint`]: Self::set_savepoint
pub fn rollback_to_savepoint(&self) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_rollback_to_savepoint(self.inner));
Ok(())
}
}
/// Get the bytes associated with a key value.
///
/// See [`get_cf_opt`] for details.
///
/// [`get_cf_opt`]: Self::get_cf_opt
pub fn get<K: AsRef<[u8]>>(&self, key: K) -> Result<Option<Vec<u8>>, Error> {
self.get_opt(key, &ReadOptions::default())
}
pub fn get_pinned<K: AsRef<[u8]>>(&self, key: K) -> Result<Option<DBPinnableSlice>, Error> {
self.get_pinned_opt(key, &ReadOptions::default())
}
/// Get the bytes associated with a key value and the given column family.
///
/// See [`get_cf_opt`] for details.
///
/// [`get_cf_opt`]: Self::get_cf_opt
pub fn get_cf<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
) -> Result<Option<Vec<u8>>, Error> {
self.get_cf_opt(cf, key, &ReadOptions::default())
}
pub fn get_pinned_cf<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
) -> Result<Option<DBPinnableSlice>, Error> {
self.get_pinned_cf_opt(cf, key, &ReadOptions::default())
}
/// Get the key and ensure that this transaction will only
/// be able to be committed if this key is not written outside this
/// transaction after it has first been read (or after the snapshot if a
/// snapshot is set in this transaction).
///
/// See [`get_for_update_cf_opt`] for details.
///
/// [`get_for_update_cf_opt`]: Self::get_for_update_cf_opt
pub fn get_for_update<K: AsRef<[u8]>>(
&self,
key: K,
exclusive: bool,
) -> Result<Option<Vec<u8>>, Error> {
self.get_for_update_opt(key, exclusive, &ReadOptions::default())
}
pub fn get_pinned_for_update<K: AsRef<[u8]>>(
&self,
key: K,
exclusive: bool,
) -> Result<Option<DBPinnableSlice>, Error> {
self.get_pinned_for_update_opt(key, exclusive, &ReadOptions::default())
}
/// Get the key in the given column family and ensure that this transaction will only
/// be able to be committed if this key is not written outside this
/// transaction after it has first been read (or after the snapshot if a
/// snapshot is set in this transaction).
///
/// See [`get_for_update_cf_opt`] for details.
///
/// [`get_for_update_cf_opt`]: Self::get_for_update_cf_opt
pub fn get_for_update_cf<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
exclusive: bool,
) -> Result<Option<Vec<u8>>, Error> {
self.get_for_update_cf_opt(cf, key, exclusive, &ReadOptions::default())
}
pub fn get_pinned_for_update_cf<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
exclusive: bool,
) -> Result<Option<DBPinnableSlice>, Error> {
self.get_pinned_for_update_cf_opt(cf, key, exclusive, &ReadOptions::default())
}
/// Returns the bytes associated with a key value with read options.
///
/// See [`get_cf_opt`] for details.
///
/// [`get_cf_opt`]: Self::get_cf_opt
pub fn get_opt<K: AsRef<[u8]>>(
&self,
key: K,
readopts: &ReadOptions,
) -> Result<Option<Vec<u8>>, Error> {
self.get_pinned_opt(key, readopts)
.map(|x| x.map(|v| v.as_ref().to_vec()))
}
pub fn get_pinned_opt<K: AsRef<[u8]>>(
&self,
key: K,
readopts: &ReadOptions,
) -> Result<Option<DBPinnableSlice>, Error> {
unsafe {
let val = ffi_try!(ffi::rocksdb_transaction_get_pinned(
self.inner,
readopts.inner,
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len(),
));
if val.is_null() {
Ok(None)
} else {
Ok(Some(DBPinnableSlice::from_c(val)))
}
}
}
/// Get the bytes associated with a key value and the given column family with read options.
///
/// This function will also read pending changes in this transaction.
/// Currently, this function will return an error of the [`MergeInProgress`] kind
/// if the most recent write to the queried key in this batch is a Merge.
///
/// [`MergeInProgress`]: crate::ErrorKind::MergeInProgress
pub fn get_cf_opt<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
readopts: &ReadOptions,
) -> Result<Option<Vec<u8>>, Error> {
self.get_pinned_cf_opt(cf, key, readopts)
.map(|x| x.map(|v| v.as_ref().to_vec()))
}
pub fn get_pinned_cf_opt<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
readopts: &ReadOptions,
) -> Result<Option<DBPinnableSlice>, Error> {
unsafe {
let val = ffi_try!(ffi::rocksdb_transaction_get_pinned_cf(
self.inner,
readopts.inner,
cf.inner(),
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len(),
));
if val.is_null() {
Ok(None)
} else {
Ok(Some(DBPinnableSlice::from_c(val)))
}
}
}
/// Get the key with read options and ensure that this transaction will only
/// be able to be committed if this key is not written outside this
/// transaction after it has first been read (or after the snapshot if a
/// snapshot is set in this transaction).
///
/// See [`get_for_update_cf_opt`] for details.
///
/// [`get_for_update_cf_opt`]: Self::get_for_update_cf_opt
pub fn get_for_update_opt<K: AsRef<[u8]>>(
&self,
key: K,
exclusive: bool,
opts: &ReadOptions,
) -> Result<Option<Vec<u8>>, Error> {
self.get_pinned_for_update_opt(key, exclusive, opts)
.map(|x| x.map(|v| v.as_ref().to_vec()))
}
pub fn get_pinned_for_update_opt<K: AsRef<[u8]>>(
&self,
key: K,
exclusive: bool,
opts: &ReadOptions,
) -> Result<Option<DBPinnableSlice>, Error> {
unsafe {
let val = ffi_try!(ffi::rocksdb_transaction_get_pinned_for_update(
self.inner,
opts.inner,
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t,
u8::from(exclusive),
));
if val.is_null() {
Ok(None)
} else {
Ok(Some(DBPinnableSlice::from_c(val)))
}
}
}
/// Get the key in the given column family with read options
/// and ensure that this transaction will only
/// be able to be committed if this key is not written outside this
/// transaction after it has first been read (or after the snapshot if a
/// snapshot is set in this transaction).
///
/// Currently, this function will return an error of the [`MergeInProgress`]
/// if the most recent write to the queried key in this batch is a Merge.
///
/// If this transaction was created by a [`TransactionDB`], it can return error of kind:
/// * [`Busy`] if there is a write conflict.
/// * [`TimedOut`] if a lock could not be acquired.
/// * [`TryAgain`] if the memtable history size is not large enough.
/// * [`MergeInProgress`] if merge operations cannot be resolved.
/// * or other errors if this key could not be read.
///
/// If this transaction was created by an `[OptimisticTransactionDB]`, `get_for_update_opt`
/// can cause [`commit`] to fail. Otherwise, it could return any error that could
/// be returned by `[DB::get]`.
///
/// [`Busy`]: crate::ErrorKind::Busy
/// [`TimedOut`]: crate::ErrorKind::TimedOut
/// [`TryAgain`]: crate::ErrorKind::TryAgain
/// [`MergeInProgress`]: crate::ErrorKind::MergeInProgress
/// [`TransactionDB`]: crate::TransactionDB
/// [`OptimisticTransactionDB`]: crate::OptimisticTransactionDB
/// [`commit`]: Self::commit
/// [`DB::get`]: crate::DB::get
pub fn get_for_update_cf_opt<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
exclusive: bool,
opts: &ReadOptions,
) -> Result<Option<Vec<u8>>, Error> {
self.get_pinned_for_update_cf_opt(cf, key, exclusive, opts)
.map(|x| x.map(|v| v.as_ref().to_vec()))
}
pub fn get_pinned_for_update_cf_opt<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
exclusive: bool,
opts: &ReadOptions,
) -> Result<Option<DBPinnableSlice>, Error> {
unsafe {
let val = ffi_try!(ffi::rocksdb_transaction_get_pinned_for_update_cf(
self.inner,
opts.inner,
cf.inner(),
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t,
u8::from(exclusive),
));
if val.is_null() {
Ok(None)
} else {
Ok(Some(DBPinnableSlice::from_c(val)))
}
}
}
/// Return the values associated with the given keys.
pub fn multi_get<K, I>(&self, keys: I) -> Vec<Result<Option<Vec<u8>>, Error>>
where
K: AsRef<[u8]>,
I: IntoIterator<Item = K>,
{
self.multi_get_opt(keys, &ReadOptions::default())
}
/// Return the values associated with the given keys using read options.
pub fn multi_get_opt<K, I>(
&self,
keys: I,
readopts: &ReadOptions,
) -> Vec<Result<Option<Vec<u8>>, Error>>
where
K: AsRef<[u8]>,
I: IntoIterator<Item = K>,
{
let (keys, keys_sizes): (Vec<Box<[u8]>>, Vec<_>) = keys
.into_iter()
.map(|k| (Box::from(k.as_ref()), k.as_ref().len()))
.unzip();
let ptr_keys: Vec<_> = keys.iter().map(|k| k.as_ptr() as *const c_char).collect();
let mut values = vec![ptr::null_mut(); keys.len()];
let mut values_sizes = vec![0_usize; keys.len()];
let mut errors = vec![ptr::null_mut(); keys.len()];
unsafe {
ffi::rocksdb_transaction_multi_get(
self.inner,
readopts.inner,
ptr_keys.len(),
ptr_keys.as_ptr(),
keys_sizes.as_ptr(),
values.as_mut_ptr(),
values_sizes.as_mut_ptr(),
errors.as_mut_ptr(),
);
}
convert_values(values, values_sizes, errors)
}
/// Return the values associated with the given keys and column families.
pub fn multi_get_cf<'a, 'b: 'a, K, I, W>(
&'a self,
keys: I,
) -> Vec<Result<Option<Vec<u8>>, Error>>
where
K: AsRef<[u8]>,
I: IntoIterator<Item = (&'b W, K)>,
W: 'b + AsColumnFamilyRef,
{
self.multi_get_cf_opt(keys, &ReadOptions::default())
}
/// Return the values associated with the given keys and column families using read options.
pub fn multi_get_cf_opt<'a, 'b: 'a, K, I, W>(
&'a self,
keys: I,
readopts: &ReadOptions,
) -> Vec<Result<Option<Vec<u8>>, Error>>
where
K: AsRef<[u8]>,
I: IntoIterator<Item = (&'b W, K)>,
W: 'b + AsColumnFamilyRef,
{
let (cfs_and_keys, keys_sizes): (Vec<(_, Box<[u8]>)>, Vec<_>) = keys
.into_iter()
.map(|(cf, key)| ((cf, Box::from(key.as_ref())), key.as_ref().len()))
.unzip();
let ptr_keys: Vec<_> = cfs_and_keys
.iter()
.map(|(_, k)| k.as_ptr() as *const c_char)
.collect();
let ptr_cfs: Vec<_> = cfs_and_keys
.iter()
.map(|(c, _)| c.inner() as *const _)
.collect();
let mut values = vec![ptr::null_mut(); ptr_keys.len()];
let mut values_sizes = vec![0_usize; ptr_keys.len()];
let mut errors = vec![ptr::null_mut(); ptr_keys.len()];
unsafe {
ffi::rocksdb_transaction_multi_get_cf(
self.inner,
readopts.inner,
ptr_cfs.as_ptr(),
ptr_keys.len(),
ptr_keys.as_ptr(),
keys_sizes.as_ptr(),
values.as_mut_ptr(),
values_sizes.as_mut_ptr(),
errors.as_mut_ptr(),
);
}
convert_values(values, values_sizes, errors)
}
/// Put the key value in default column family and do conflict checking on the key.
///
/// See [`put_cf`] for details.
///
/// [`put_cf`]: Self::put_cf
pub fn put<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, value: V) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_put(
self.inner,
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t,
value.as_ref().as_ptr() as *const c_char,
value.as_ref().len() as size_t,
));
Ok(())
}
}
/// Put the key value in the given column famuly and do conflict checking on the key.
///
/// If this transaction was created by a [`TransactionDB`], it can return error of kind:
/// * [`Busy`] if there is a write conflict.
/// * [`TimedOut`] if a lock could not be acquired.
/// * [`TryAgain`] if the memtable history size is not large enough.
/// * [`MergeInProgress`] if merge operations cannot be resolved.
/// * or other errors on unexpected failures.
///
/// [`Busy`]: crate::ErrorKind::Busy
/// [`TimedOut`]: crate::ErrorKind::TimedOut
/// [`TryAgain`]: crate::ErrorKind::TryAgain
/// [`MergeInProgress`]: crate::ErrorKind::MergeInProgress
/// [`TransactionDB`]: crate::TransactionDB
/// [`OptimisticTransactionDB`]: crate::OptimisticTransactionDB
pub fn put_cf<K: AsRef<[u8]>, V: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
value: V,
) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_put_cf(
self.inner,
cf.inner(),
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t,
value.as_ref().as_ptr() as *const c_char,
value.as_ref().len() as size_t,
));
Ok(())
}
}
/// Merge value with existing value of key, and also do conflict checking on the key.
///
/// See [`merge_cf`] for details.
///
/// [`merge_cf`]: Self::merge_cf
pub fn merge<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, value: V) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_merge(
self.inner,
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t,
value.as_ref().as_ptr() as *const c_char,
value.as_ref().len() as size_t
));
Ok(())
}
}
/// Merge `value` with existing value of `key` in the given column family,
/// and also do conflict checking on the key.
///
/// If this transaction was created by a [`TransactionDB`], it can return error of kind:
/// * [`Busy`] if there is a write conflict.
/// * [`TimedOut`] if a lock could not be acquired.
/// * [`TryAgain`] if the memtable history size is not large enough.
/// * [`MergeInProgress`] if merge operations cannot be resolved.
/// * or other errors on unexpected failures.
///
/// [`Busy`]: crate::ErrorKind::Busy
/// [`TimedOut`]: crate::ErrorKind::TimedOut
/// [`TryAgain`]: crate::ErrorKind::TryAgain
/// [`MergeInProgress`]: crate::ErrorKind::MergeInProgress
/// [`TransactionDB`]: crate::TransactionDB
pub fn merge_cf<K: AsRef<[u8]>, V: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
value: V,
) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_merge_cf(
self.inner,
cf.inner(),
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t,
value.as_ref().as_ptr() as *const c_char,
value.as_ref().len() as size_t
));
Ok(())
}
}
/// Delete the key value if it exists and do conflict checking on the key.
///
/// See [`delete_cf`] for details.
///
/// [`delete_cf`]: Self::delete_cf
pub fn delete<K: AsRef<[u8]>>(&self, key: K) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_delete(
self.inner,
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t
));
}
Ok(())
}
/// Delete the key value in the given column family and do conflict checking.
///
/// If this transaction was created by a [`TransactionDB`], it can return error of kind:
/// * [`Busy`] if there is a write conflict.
/// * [`TimedOut`] if a lock could not be acquired.
/// * [`TryAgain`] if the memtable history size is not large enough.
/// * [`MergeInProgress`] if merge operations cannot be resolved.
/// * or other errors on unexpected failures.
///
/// [`Busy`]: crate::ErrorKind::Busy
/// [`TimedOut`]: crate::ErrorKind::TimedOut
/// [`TryAgain`]: crate::ErrorKind::TryAgain
/// [`MergeInProgress`]: crate::ErrorKind::MergeInProgress
/// [`TransactionDB`]: crate::TransactionDB
pub fn delete_cf<K: AsRef<[u8]>>(
&self,
cf: &impl AsColumnFamilyRef,
key: K,
) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_delete_cf(
self.inner,
cf.inner(),
key.as_ref().as_ptr() as *const c_char,
key.as_ref().len() as size_t
));
}
Ok(())
}
pub fn iterator<'a: 'b, 'b>(
&'a self,
mode: IteratorMode,
) -> DBIteratorWithThreadMode<'b, Self> {
let readopts = ReadOptions::default();
self.iterator_opt(mode, readopts)
}
pub fn iterator_opt<'a: 'b, 'b>(
&'a self,
mode: IteratorMode,
readopts: ReadOptions,
) -> DBIteratorWithThreadMode<'b, Self> {
DBIteratorWithThreadMode::new(self, readopts, mode)
}
/// Opens an iterator using the provided ReadOptions.
/// This is used when you want to iterate over a specific ColumnFamily with a modified ReadOptions.
pub fn iterator_cf_opt<'a: 'b, 'b>(
&'a self,
cf_handle: &impl AsColumnFamilyRef,
readopts: ReadOptions,
mode: IteratorMode,
) -> DBIteratorWithThreadMode<'b, Self> {
DBIteratorWithThreadMode::new_cf(self, cf_handle.inner(), readopts, mode)
}
/// Opens an iterator with `set_total_order_seek` enabled.
/// This must be used to iterate across prefixes when `set_memtable_factory` has been called
/// with a Hash-based implementation.
pub fn full_iterator<'a: 'b, 'b>(
&'a self,
mode: IteratorMode,
) -> DBIteratorWithThreadMode<'b, Self> {
let mut opts = ReadOptions::default();
opts.set_total_order_seek(true);
DBIteratorWithThreadMode::new(self, opts, mode)
}
pub fn prefix_iterator<'a: 'b, 'b, P: AsRef<[u8]>>(
&'a self,
prefix: P,
) -> DBIteratorWithThreadMode<'b, Self> {
let mut opts = ReadOptions::default();
opts.set_prefix_same_as_start(true);
DBIteratorWithThreadMode::new(
self,
opts,
IteratorMode::From(prefix.as_ref(), Direction::Forward),
)
}
pub fn iterator_cf<'a: 'b, 'b>(
&'a self,
cf_handle: &impl AsColumnFamilyRef,
mode: IteratorMode,
) -> DBIteratorWithThreadMode<'b, Self> {
let opts = ReadOptions::default();
DBIteratorWithThreadMode::new_cf(self, cf_handle.inner(), opts, mode)
}
pub fn full_iterator_cf<'a: 'b, 'b>(
&'a self,
cf_handle: &impl AsColumnFamilyRef,
mode: IteratorMode,
) -> DBIteratorWithThreadMode<'b, Self> {
let mut opts = ReadOptions::default();
opts.set_total_order_seek(true);
DBIteratorWithThreadMode::new_cf(self, cf_handle.inner(), opts, mode)
}
pub fn prefix_iterator_cf<'a, P: AsRef<[u8]>>(
&'a self,
cf_handle: &impl AsColumnFamilyRef,
prefix: P,
) -> DBIteratorWithThreadMode<'a, Self> {
let mut opts = ReadOptions::default();
opts.set_prefix_same_as_start(true);
DBIteratorWithThreadMode::<'a, Self>::new_cf(
self,
cf_handle.inner(),
opts,
IteratorMode::From(prefix.as_ref(), Direction::Forward),
)
}
/// Opens a raw iterator over the database, using the default read options
pub fn raw_iterator<'a: 'b, 'b>(&'a self) -> DBRawIteratorWithThreadMode<'b, Self> {
let opts = ReadOptions::default();
DBRawIteratorWithThreadMode::new(self, opts)
}
/// Opens a raw iterator over the given column family, using the default read options
pub fn raw_iterator_cf<'a: 'b, 'b>(
&'a self,
cf_handle: &impl AsColumnFamilyRef,
) -> DBRawIteratorWithThreadMode<'b, Self> {
let opts = ReadOptions::default();
DBRawIteratorWithThreadMode::new_cf(self, cf_handle.inner(), opts)
}
/// Opens a raw iterator over the database, using the given read options
pub fn raw_iterator_opt<'a: 'b, 'b>(
&'a self,
readopts: ReadOptions,
) -> DBRawIteratorWithThreadMode<'b, Self> {
DBRawIteratorWithThreadMode::new(self, readopts)
}
/// Opens a raw iterator over the given column family, using the given read options
pub fn raw_iterator_cf_opt<'a: 'b, 'b>(
&'a self,
cf_handle: &impl AsColumnFamilyRef,
readopts: ReadOptions,
) -> DBRawIteratorWithThreadMode<'b, Self> {
DBRawIteratorWithThreadMode::new_cf(self, cf_handle.inner(), readopts)
}
pub fn get_writebatch(&self) -> WriteBatchWithTransaction<true> {
unsafe {
let wi = ffi::rocksdb_transaction_get_writebatch_wi(self.inner);
let mut len: usize = 0;
let ptr = ffi::rocksdb_writebatch_wi_data(wi, &mut len as _);
let writebatch = ffi::rocksdb_writebatch_create_from(ptr, len);
ffi::rocksdb_free(wi as *mut c_void);
WriteBatchWithTransaction { inner: writebatch }
}
}
pub fn rebuild_from_writebatch(
&self,
writebatch: &WriteBatchWithTransaction<true>,
) -> Result<(), Error> {
unsafe {
ffi_try!(ffi::rocksdb_transaction_rebuild_from_writebatch(
self.inner,
writebatch.inner
));
}
Ok(())
}
}
impl<'db, DB> Drop for Transaction<'db, DB> {
fn drop(&mut self) {
unsafe {
ffi::rocksdb_transaction_destroy(self.inner);
}
}
}