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
// 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 crate::ffi;
pub struct TransactionOptions {
pub(crate) inner: *mut ffi::rocksdb_transaction_options_t,
}
unsafe impl Send for TransactionOptions {}
unsafe impl Sync for TransactionOptions {}
impl Default for TransactionOptions {
fn default() -> Self {
let txn_opts = unsafe { ffi::rocksdb_transaction_options_create() };
assert!(
!txn_opts.is_null(),
"Could not create RocksDB transaction options"
);
Self { inner: txn_opts }
}
}
impl TransactionOptions {
pub fn new() -> TransactionOptions {
TransactionOptions::default()
}
pub fn set_skip_prepare(&mut self, skip_prepare: bool) {
unsafe {
ffi::rocksdb_transaction_options_set_set_snapshot(self.inner, u8::from(skip_prepare));
}
}
/// Specifies use snapshot or not.
///
/// Default: false.
///
/// If a transaction has a snapshot set, the transaction will ensure that
/// any keys successfully written(or fetched via `get_for_update`) have not
/// been modified outside this transaction since the time the snapshot was
/// set.
/// If a snapshot has not been set, the transaction guarantees that keys have
/// not been modified since the time each key was first written (or fetched via
/// `get_for_update`).
///
/// Using snapshot will provide stricter isolation guarantees at the
/// expense of potentially more transaction failures due to conflicts with
/// other writes.
///
/// Calling `set_snapshot` will not affect the version of Data returned by `get`
/// methods.
pub fn set_snapshot(&mut self, snapshot: bool) {
unsafe {
ffi::rocksdb_transaction_options_set_set_snapshot(self.inner, u8::from(snapshot));
}
}
/// Specifies whether detect deadlock or not.
///
/// Setting to true means that before acquiring locks, this transaction will
/// check if doing so will cause a deadlock. If so, it will return with
/// Status::Busy. The user should retry their transaction.
///
/// Default: false.
pub fn set_deadlock_detect(&mut self, deadlock_detect: bool) {
unsafe {
ffi::rocksdb_transaction_options_set_deadlock_detect(
self.inner,
u8::from(deadlock_detect),
);
}
}
/// Specifies the wait timeout in milliseconds when a transaction attempts to lock a key.
///
/// If 0, no waiting is done if a lock cannot instantly be acquired.
/// If negative, transaction lock timeout in `TransactionDBOptions` will be used.
///
/// Default: -1.
pub fn set_lock_timeout(&mut self, lock_timeout: i64) {
unsafe {
ffi::rocksdb_transaction_options_set_lock_timeout(self.inner, lock_timeout);
}
}
/// Specifies expiration duration in milliseconds.
///
/// If non-negative, transactions that last longer than this many milliseconds will fail to commit.
/// If not set, a forgotten transaction that is never committed, rolled back, or deleted
/// will never relinquish any locks it holds. This could prevent keys from being by other writers.
///
/// Default: -1.
pub fn set_expiration(&mut self, expiration: i64) {
unsafe {
ffi::rocksdb_transaction_options_set_expiration(self.inner, expiration);
}
}
/// Specifies the number of traversals to make during deadlock detection.
///
/// Default: 50.
pub fn set_deadlock_detect_depth(&mut self, depth: i64) {
unsafe {
ffi::rocksdb_transaction_options_set_deadlock_detect_depth(self.inner, depth);
}
}
/// Specifies the maximum number of bytes used for the write batch. 0 means no limit.
///
/// Default: 0.
pub fn set_max_write_batch_size(&mut self, size: usize) {
unsafe {
ffi::rocksdb_transaction_options_set_max_write_batch_size(self.inner, size);
}
}
}
impl Drop for TransactionOptions {
fn drop(&mut self) {
unsafe {
ffi::rocksdb_transaction_options_destroy(self.inner);
}
}
}
pub struct TransactionDBOptions {
pub(crate) inner: *mut ffi::rocksdb_transactiondb_options_t,
}
unsafe impl Send for TransactionDBOptions {}
unsafe impl Sync for TransactionDBOptions {}
impl Default for TransactionDBOptions {
fn default() -> Self {
let txn_db_opts = unsafe { ffi::rocksdb_transactiondb_options_create() };
assert!(
!txn_db_opts.is_null(),
"Could not create RocksDB transaction_db options"
);
Self { inner: txn_db_opts }
}
}
impl TransactionDBOptions {
pub fn new() -> TransactionDBOptions {
TransactionDBOptions::default()
}
/// Specifies the wait timeout in milliseconds when writing a key
/// outside a transaction (i.e. by calling `TransactionDB::put` directly).
///
/// If 0, no waiting is done if a lock cannot instantly be acquired.
/// If negative, there is no timeout and will block indefinitely when acquiring
/// a lock.
///
/// Not using a timeout can lead to deadlocks. Currently, there
/// is no deadlock-detection to recover from a deadlock. While DB writes
/// cannot deadlock with other DB writes, they can deadlock with a transaction.
/// A negative timeout should only be used if all transactions have a small
/// expiration set.
///
/// Default: 1000(1s).
pub fn set_default_lock_timeout(&mut self, default_lock_timeout: i64) {
unsafe {
ffi::rocksdb_transactiondb_options_set_default_lock_timeout(
self.inner,
default_lock_timeout,
);
}
}
/// Specifies the default wait timeout in milliseconds when a transaction
/// attempts to lock a key if not specified in `TransactionOptions`.
///
/// If 0, no waiting is done if a lock cannot instantly be acquired.
/// If negative, there is no timeout. Not using a timeout is not recommended
/// as it can lead to deadlocks. Currently, there is no deadlock-detection to
/// recover from a deadlock.
///
/// Default: 1000(1s).
pub fn set_txn_lock_timeout(&mut self, txn_lock_timeout: i64) {
unsafe {
ffi::rocksdb_transactiondb_options_set_transaction_lock_timeout(
self.inner,
txn_lock_timeout,
);
}
}
/// Specifies the maximum number of keys that can be locked at the same time
/// per column family.
///
/// If the number of locked keys is greater than `max_num_locks`, transaction
/// `writes` (or `get_for_update`) will return an error.
/// If this value is not positive, no limit will be enforced.
///
/// Default: -1.
pub fn set_max_num_locks(&mut self, max_num_locks: i64) {
unsafe {
ffi::rocksdb_transactiondb_options_set_max_num_locks(self.inner, max_num_locks);
}
}
/// Specifies lock table stripes count.
///
/// Increasing this value will increase the concurrency by dividing the lock
/// table (per column family) into more sub-tables, each with their own
/// separate mutex.
///
/// Default: 16.
pub fn set_num_stripes(&mut self, num_stripes: usize) {
unsafe {
ffi::rocksdb_transactiondb_options_set_num_stripes(self.inner, num_stripes);
}
}
}
impl Drop for TransactionDBOptions {
fn drop(&mut self) {
unsafe {
ffi::rocksdb_transactiondb_options_destroy(self.inner);
}
}
}
pub struct OptimisticTransactionOptions {
pub(crate) inner: *mut ffi::rocksdb_optimistictransaction_options_t,
}
unsafe impl Send for OptimisticTransactionOptions {}
unsafe impl Sync for OptimisticTransactionOptions {}
impl Default for OptimisticTransactionOptions {
fn default() -> Self {
let txn_opts = unsafe { ffi::rocksdb_optimistictransaction_options_create() };
assert!(
!txn_opts.is_null(),
"Could not create RocksDB optimistic transaction options"
);
Self { inner: txn_opts }
}
}
impl OptimisticTransactionOptions {
pub fn new() -> OptimisticTransactionOptions {
OptimisticTransactionOptions::default()
}
/// Specifies use snapshot or not.
///
/// Default: false.
///
/// If a transaction has a snapshot set, the transaction will ensure that
/// any keys successfully written(or fetched via `get_for_update`) have not
/// been modified outside the transaction since the time the snapshot was
/// set.
/// If a snapshot has not been set, the transaction guarantees that keys have
/// not been modified since the time each key was first written (or fetched via
/// `get_for_update`).
///
/// Using snapshot will provide stricter isolation guarantees at the
/// expense of potentially more transaction failures due to conflicts with
/// other writes.
///
/// Calling `set_snapshot` will not affect the version of Data returned by `get`
/// methods.
pub fn set_snapshot(&mut self, snapshot: bool) {
unsafe {
ffi::rocksdb_optimistictransaction_options_set_set_snapshot(
self.inner,
u8::from(snapshot),
);
}
}
}
impl Drop for OptimisticTransactionOptions {
fn drop(&mut self) {
unsafe {
ffi::rocksdb_optimistictransaction_options_destroy(self.inner);
}
}
}