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
use error;
use foundationdb_sys as fdb;
use std;
#[derive(Clone, Debug)]
pub enum NetworkOption {
/// IP:PORT
///
/// Deprecated
LocalAddress(String),
/// path to cluster file
///
/// Deprecated
ClusterFile(String),
/// path to output directory (or NULL for current working directory)
///
/// Enables trace output to a file in a directory of the clients choosing
TraceEnable(String),
/// max size of a single trace output file
///
/// Sets the maximum size in bytes of a single trace output file. This value should be in the range ``[0, INT64_MAX]``. If the value is set to 0, there is no limit on individual file size. The default is a maximum size of 10,485,760 bytes.
TraceRollSize(u32),
/// max total size of trace files
///
/// Sets the maximum size of all the trace output files put together. This value should be in the range ``[0, INT64_MAX]``. If the value is set to 0, there is no limit on the total size of the files. The default is a maximum size of 104,857,600 bytes. If the default roll size is used, this means that a maximum of 10 trace files will be written at a time.
TraceMaxLogsSize(u32),
/// value of the logGroup attribute
///
/// Sets the 'logGroup' attribute with the specified value for all events in the trace output files. The default log group is 'default'.
TraceLogGroup(String),
/// knob_name=knob_value
///
/// Set internal tuning or debugging knobs
Knob(String),
/// file path or linker-resolved name
///
/// Set the TLS plugin to load. This option, if used, must be set before any other TLS options
TlsPlugin(String),
/// certificates
///
/// Set the certificate chain
TlsCertByte(Vec<u8>),
/// file path
///
/// Set the file from which to load the certificate chain
TlsCertPath(String),
/// key
///
/// Set the private key corresponding to your own certificate
TlsKeyByte(Vec<u8>),
/// file path
///
/// Set the file from which to load the private key corresponding to your own certificate
TlsKeyPath(String),
/// verification pattern
///
/// Set the peer certificate field verification criteria
TlsVerifyPeer(Vec<u8>),
BuggifyEnable,
BuggifyDisable,
/// probability expressed as a percentage between 0 and 100
///
/// Set the probability of a BUGGIFY section being active for the current execution. Only applies to code paths first traversed AFTER this option is changed.
BuggifySectionActivatedProbability(u32),
/// probability expressed as a percentage between 0 and 100
///
/// Set the probability of an active BUGGIFY section being fired
BuggifySectionFiredProbability(u32),
/// Disables the multi-version client API and instead uses the local client directly. Must be set before setting up the network.
DisableMultiVersionClientApi,
/// If set, callbacks from external client libraries can be called from threads created by the FoundationDB client library. Otherwise, callbacks will be called from either the thread used to add the callback or the network thread. Setting this option can improve performance when connected using an external client, but may not be safe to use in all environments. Must be set before setting up the network. WARNING: This feature is considered experimental at this time.
CallbacksOnExternalThread,
/// path to client library
///
/// Adds an external client library for use by the multi-version client API. Must be set before setting up the network.
ExternalClientLibrary(String),
/// path to directory containing client libraries
///
/// Searches the specified path for dynamic libraries and adds them to the list of client libraries for use by the multi-version client API. Must be set before setting up the network.
ExternalClientDirectory(String),
/// Prevents connections through the local client, allowing only connections through externally loaded client libraries. Intended primarily for testing.
DisableLocalClient,
/// Disables logging of client statistics, such as sampled transaction activity.
DisableClientStatisticsLogging,
/// Enables debugging feature to perform slow task profiling. Requires trace logging to be enabled. WARNING: this feature is not recommended for use in production.
EnableSlowTaskProfiling,
}
impl NetworkOption {
pub fn code(&self) -> fdb::FDBNetworkOption {
match *self {
NetworkOption::LocalAddress(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_LOCAL_ADDRESS
}
NetworkOption::ClusterFile(ref _v) => fdb::FDBNetworkOption_FDB_NET_OPTION_CLUSTER_FILE,
NetworkOption::TraceEnable(ref _v) => fdb::FDBNetworkOption_FDB_NET_OPTION_TRACE_ENABLE,
NetworkOption::TraceRollSize(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_TRACE_ROLL_SIZE
}
NetworkOption::TraceMaxLogsSize(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_TRACE_MAX_LOGS_SIZE
}
NetworkOption::TraceLogGroup(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_TRACE_LOG_GROUP
}
NetworkOption::Knob(ref _v) => fdb::FDBNetworkOption_FDB_NET_OPTION_KNOB,
NetworkOption::TlsPlugin(ref _v) => fdb::FDBNetworkOption_FDB_NET_OPTION_TLS_PLUGIN,
NetworkOption::TlsCertByte(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_TLS_CERT_BYTES
}
NetworkOption::TlsCertPath(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_TLS_CERT_PATH
}
NetworkOption::TlsKeyByte(ref _v) => fdb::FDBNetworkOption_FDB_NET_OPTION_TLS_KEY_BYTES,
NetworkOption::TlsKeyPath(ref _v) => fdb::FDBNetworkOption_FDB_NET_OPTION_TLS_KEY_PATH,
NetworkOption::TlsVerifyPeer(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_TLS_VERIFY_PEERS
}
NetworkOption::BuggifyEnable => fdb::FDBNetworkOption_FDB_NET_OPTION_BUGGIFY_ENABLE,
NetworkOption::BuggifyDisable => fdb::FDBNetworkOption_FDB_NET_OPTION_BUGGIFY_DISABLE,
NetworkOption::BuggifySectionActivatedProbability(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_BUGGIFY_SECTION_ACTIVATED_PROBABILITY
}
NetworkOption::BuggifySectionFiredProbability(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_BUGGIFY_SECTION_FIRED_PROBABILITY
}
NetworkOption::DisableMultiVersionClientApi => {
fdb::FDBNetworkOption_FDB_NET_OPTION_DISABLE_MULTI_VERSION_CLIENT_API
}
NetworkOption::CallbacksOnExternalThread => {
fdb::FDBNetworkOption_FDB_NET_OPTION_CALLBACKS_ON_EXTERNAL_THREADS
}
NetworkOption::ExternalClientLibrary(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_EXTERNAL_CLIENT_LIBRARY
}
NetworkOption::ExternalClientDirectory(ref _v) => {
fdb::FDBNetworkOption_FDB_NET_OPTION_EXTERNAL_CLIENT_DIRECTORY
}
NetworkOption::DisableLocalClient => {
fdb::FDBNetworkOption_FDB_NET_OPTION_DISABLE_LOCAL_CLIENT
}
NetworkOption::DisableClientStatisticsLogging => {
fdb::FDBNetworkOption_FDB_NET_OPTION_DISABLE_CLIENT_STATISTICS_LOGGING
}
NetworkOption::EnableSlowTaskProfiling => {
fdb::FDBNetworkOption_FDB_NET_OPTION_ENABLE_SLOW_TASK_PROFILING
}
}
}
pub unsafe fn apply(&self) -> std::result::Result<(), error::Error> {
let code = self.code();
let err = match *self {
NetworkOption::LocalAddress(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::ClusterFile(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TraceEnable(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TraceRollSize(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_network_set_option(code, data.as_ptr() as *const u8, 8)
}
NetworkOption::TraceMaxLogsSize(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_network_set_option(code, data.as_ptr() as *const u8, 8)
}
NetworkOption::TraceLogGroup(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::Knob(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TlsPlugin(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TlsCertByte(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TlsCertPath(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TlsKeyByte(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TlsKeyPath(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::TlsVerifyPeer(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::BuggifyEnable => fdb::fdb_network_set_option(code, std::ptr::null(), 0),
NetworkOption::BuggifyDisable => fdb::fdb_network_set_option(code, std::ptr::null(), 0),
NetworkOption::BuggifySectionActivatedProbability(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_network_set_option(code, data.as_ptr() as *const u8, 8)
}
NetworkOption::BuggifySectionFiredProbability(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_network_set_option(code, data.as_ptr() as *const u8, 8)
}
NetworkOption::DisableMultiVersionClientApi => {
fdb::fdb_network_set_option(code, std::ptr::null(), 0)
}
NetworkOption::CallbacksOnExternalThread => {
fdb::fdb_network_set_option(code, std::ptr::null(), 0)
}
NetworkOption::ExternalClientLibrary(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::ExternalClientDirectory(ref v) => {
fdb::fdb_network_set_option(code, v.as_ptr() as *const u8, v.len() as i32)
}
NetworkOption::DisableLocalClient => {
fdb::fdb_network_set_option(code, std::ptr::null(), 0)
}
NetworkOption::DisableClientStatisticsLogging => {
fdb::fdb_network_set_option(code, std::ptr::null(), 0)
}
NetworkOption::EnableSlowTaskProfiling => {
fdb::fdb_network_set_option(code, std::ptr::null(), 0)
}
};
if err != 0 {
Err(error::Error::from(err))
} else {
Ok(())
}
}
}
#[derive(Clone, Debug)]
pub enum DatabaseOption {
/// Max location cache entries
///
/// Set the size of the client location cache. Raising this value can boost performance in very large databases where clients access data in a near-random pattern. Defaults to 100000.
LocationCacheSize(u32),
/// Max outstanding watches
///
/// Set the maximum number of watches allowed to be outstanding on a database connection. Increasing this number could result in increased resource usage. Reducing this number will not cancel any outstanding watches. Defaults to 10000 and cannot be larger than 1000000.
MaxWatch(u32),
/// Hexadecimal ID
///
/// Specify the machine ID that was passed to fdbserver processes running on the same machine as this client, for better location-aware load balancing.
MachineId(String),
/// Hexadecimal ID
///
/// Specify the datacenter ID that was passed to fdbserver processes running in the same datacenter as this client, for better location-aware load balancing.
DatacenterId(String),
}
impl DatabaseOption {
pub fn code(&self) -> fdb::FDBDatabaseOption {
match *self {
DatabaseOption::LocationCacheSize(ref _v) => {
fdb::FDBDatabaseOption_FDB_DB_OPTION_LOCATION_CACHE_SIZE
}
DatabaseOption::MaxWatch(ref _v) => fdb::FDBDatabaseOption_FDB_DB_OPTION_MAX_WATCHES,
DatabaseOption::MachineId(ref _v) => fdb::FDBDatabaseOption_FDB_DB_OPTION_MACHINE_ID,
DatabaseOption::DatacenterId(ref _v) => {
fdb::FDBDatabaseOption_FDB_DB_OPTION_DATACENTER_ID
}
}
}
pub unsafe fn apply(
&self,
target: *mut fdb::FDBDatabase,
) -> std::result::Result<(), error::Error> {
let code = self.code();
let err = match *self {
DatabaseOption::LocationCacheSize(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_database_set_option(target, code, data.as_ptr() as *const u8, 8)
}
DatabaseOption::MaxWatch(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_database_set_option(target, code, data.as_ptr() as *const u8, 8)
}
DatabaseOption::MachineId(ref v) => {
fdb::fdb_database_set_option(target, code, v.as_ptr() as *const u8, v.len() as i32)
}
DatabaseOption::DatacenterId(ref v) => {
fdb::fdb_database_set_option(target, code, v.as_ptr() as *const u8, v.len() as i32)
}
};
if err != 0 {
Err(error::Error::from(err))
} else {
Ok(())
}
}
}
#[derive(Clone, Debug)]
pub enum TransactionOption {
/// The transaction, if not self-conflicting, may be committed a second time after commit succeeds, in the event of a fault
CausalWriteRisky,
/// The read version will be committed, and usually will be the latest committed, but might not be the latest committed in the event of a fault or partition
CausalReadRisky,
CausalReadDisable,
/// The next write performed on this transaction will not generate a write conflict range. As a result, other transactions which read the key(s) being modified by the next write will not conflict with this transaction. Care needs to be taken when using this option on a transaction that is shared between multiple threads. When setting this option, write conflict ranges will be disabled on the next write operation, regardless of what thread it is on.
NextWriteNoWriteConflictRange,
/// Committing this transaction will bypass the normal load balancing across proxies and go directly to the specifically nominated 'first proxy'.
CommitOnFirstProxy,
CheckWritesEnable,
/// Reads performed by a transaction will not see any prior mutations that occured in that transaction, instead seeing the value which was in the database at the transaction's read version. This option may provide a small performance benefit for the client, but also disables a number of client-side optimizations which are beneficial for transactions which tend to read and write the same keys within a single transaction.
ReadYourWritesDisable,
/// Disables read-ahead caching for range reads. Under normal operation, a transaction will read extra rows from the database into cache if range reads are used to page through a series of data one row at a time (i.e. if a range read with a one row limit is followed by another one row range read starting immediately after the result of the first).
ReadAheadDisable,
DurabilityDatacenter,
DurabilityRisky,
DurabilityDevNullIsWebScale,
/// Specifies that this transaction should be treated as highest priority and that lower priority transactions should block behind this one. Use is discouraged outside of low-level tools
PrioritySystemImmediate,
/// Specifies that this transaction should be treated as low priority and that default priority transactions should be processed first. Useful for doing batch work simultaneously with latency-sensitive work
PriorityBatch,
/// This is a write-only transaction which sets the initial configuration. This option is designed for use by database system tools only.
InitializeNewDatabase,
/// Allows this transaction to read and modify system keys (those that start with the byte 0xFF)
AccessSystemKey,
/// Allows this transaction to read system keys (those that start with the byte 0xFF)
ReadSystemKey,
DebugDump,
/// Optional transaction name
///
DebugRetryLogging(String),
/// String identifier to be used in the logs when tracing this transaction. The identifier must not exceed 100 characters.
///
/// Enables tracing for this transaction and logs results to the client trace logs. Client trace logging must be enabled to get log output.
TransactionLoggingEnable(String),
/// value in milliseconds of timeout
///
/// Set a timeout in milliseconds which, when elapsed, will cause the transaction automatically to be cancelled. Valid parameter values are ``[0, INT_MAX]``. If set to 0, will disable all timeouts. All pending and any future uses of the transaction will throw an exception. The transaction can be used again after it is reset. Like all transaction options, a timeout must be reset after a call to onError. This behavior allows the user to make the timeout dynamic.
Timeout(u32),
/// number of times to retry
///
/// Set a maximum number of retries after which additional calls to onError will throw the most recently seen error code. Valid parameter values are ``[-1, INT_MAX]``. If set to -1, will disable the retry limit. Like all transaction options, the retry limit must be reset after a call to onError. This behavior allows the user to make the retry limit dynamic.
RetryLimit(u32),
/// value in milliseconds of maximum delay
///
/// Set the maximum amount of backoff delay incurred in the call to onError if the error is retryable. Defaults to 1000 ms. Valid parameter values are ``[0, INT_MAX]``. Like all transaction options, the maximum retry delay must be reset after a call to onError. If the maximum retry delay is less than the current retry delay of the transaction, then the current retry delay will be clamped to the maximum retry delay.
MaxRetryDelay(u32),
/// Snapshot read operations will see the results of writes done in the same transaction.
SnapshotRywEnable,
/// Snapshot read operations will not see the results of writes done in the same transaction.
SnapshotRywDisable,
/// The transaction can read and write to locked databases, and is resposible for checking that it took the lock.
LockAware,
/// By default, operations that are performed on a transaction while it is being committed will not only fail themselves, but they will attempt to fail other in-flight operations (such as the commit) as well. This behavior is intended to help developers discover situations where operations could be unintentionally executed after the transaction has been reset. Setting this option removes that protection, causing only the offending operation to fail.
UsedDuringCommitProtectionDisable,
/// The transaction can read from locked databases.
ReadLockAware,
}
impl TransactionOption {
pub fn code(&self) -> fdb::FDBTransactionOption {
match *self {
TransactionOption::CausalWriteRisky => {
fdb::FDBTransactionOption_FDB_TR_OPTION_CAUSAL_WRITE_RISKY
}
TransactionOption::CausalReadRisky => {
fdb::FDBTransactionOption_FDB_TR_OPTION_CAUSAL_READ_RISKY
}
TransactionOption::CausalReadDisable => {
fdb::FDBTransactionOption_FDB_TR_OPTION_CAUSAL_READ_DISABLE
}
TransactionOption::NextWriteNoWriteConflictRange => {
fdb::FDBTransactionOption_FDB_TR_OPTION_NEXT_WRITE_NO_WRITE_CONFLICT_RANGE
}
TransactionOption::CommitOnFirstProxy => {
fdb::FDBTransactionOption_FDB_TR_OPTION_COMMIT_ON_FIRST_PROXY
}
TransactionOption::CheckWritesEnable => {
fdb::FDBTransactionOption_FDB_TR_OPTION_CHECK_WRITES_ENABLE
}
TransactionOption::ReadYourWritesDisable => {
fdb::FDBTransactionOption_FDB_TR_OPTION_READ_YOUR_WRITES_DISABLE
}
TransactionOption::ReadAheadDisable => {
fdb::FDBTransactionOption_FDB_TR_OPTION_READ_AHEAD_DISABLE
}
TransactionOption::DurabilityDatacenter => {
fdb::FDBTransactionOption_FDB_TR_OPTION_DURABILITY_DATACENTER
}
TransactionOption::DurabilityRisky => {
fdb::FDBTransactionOption_FDB_TR_OPTION_DURABILITY_RISKY
}
TransactionOption::DurabilityDevNullIsWebScale => {
fdb::FDBTransactionOption_FDB_TR_OPTION_DURABILITY_DEV_NULL_IS_WEB_SCALE
}
TransactionOption::PrioritySystemImmediate => {
fdb::FDBTransactionOption_FDB_TR_OPTION_PRIORITY_SYSTEM_IMMEDIATE
}
TransactionOption::PriorityBatch => {
fdb::FDBTransactionOption_FDB_TR_OPTION_PRIORITY_BATCH
}
TransactionOption::InitializeNewDatabase => {
fdb::FDBTransactionOption_FDB_TR_OPTION_INITIALIZE_NEW_DATABASE
}
TransactionOption::AccessSystemKey => {
fdb::FDBTransactionOption_FDB_TR_OPTION_ACCESS_SYSTEM_KEYS
}
TransactionOption::ReadSystemKey => {
fdb::FDBTransactionOption_FDB_TR_OPTION_READ_SYSTEM_KEYS
}
TransactionOption::DebugDump => fdb::FDBTransactionOption_FDB_TR_OPTION_DEBUG_DUMP,
TransactionOption::DebugRetryLogging(ref _v) => {
fdb::FDBTransactionOption_FDB_TR_OPTION_DEBUG_RETRY_LOGGING
}
TransactionOption::TransactionLoggingEnable(ref _v) => {
fdb::FDBTransactionOption_FDB_TR_OPTION_TRANSACTION_LOGGING_ENABLE
}
TransactionOption::Timeout(ref _v) => fdb::FDBTransactionOption_FDB_TR_OPTION_TIMEOUT,
TransactionOption::RetryLimit(ref _v) => {
fdb::FDBTransactionOption_FDB_TR_OPTION_RETRY_LIMIT
}
TransactionOption::MaxRetryDelay(ref _v) => {
fdb::FDBTransactionOption_FDB_TR_OPTION_MAX_RETRY_DELAY
}
TransactionOption::SnapshotRywEnable => {
fdb::FDBTransactionOption_FDB_TR_OPTION_SNAPSHOT_RYW_ENABLE
}
TransactionOption::SnapshotRywDisable => {
fdb::FDBTransactionOption_FDB_TR_OPTION_SNAPSHOT_RYW_DISABLE
}
TransactionOption::LockAware => fdb::FDBTransactionOption_FDB_TR_OPTION_LOCK_AWARE,
TransactionOption::UsedDuringCommitProtectionDisable => {
fdb::FDBTransactionOption_FDB_TR_OPTION_USED_DURING_COMMIT_PROTECTION_DISABLE
}
TransactionOption::ReadLockAware => {
fdb::FDBTransactionOption_FDB_TR_OPTION_READ_LOCK_AWARE
}
}
}
pub unsafe fn apply(
&self,
target: *mut fdb::FDBTransaction,
) -> std::result::Result<(), error::Error> {
let code = self.code();
let err = match *self {
TransactionOption::CausalWriteRisky => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::CausalReadRisky => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::CausalReadDisable => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::NextWriteNoWriteConflictRange => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::CommitOnFirstProxy => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::CheckWritesEnable => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::ReadYourWritesDisable => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::ReadAheadDisable => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::DurabilityDatacenter => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::DurabilityRisky => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::DurabilityDevNullIsWebScale => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::PrioritySystemImmediate => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::PriorityBatch => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::InitializeNewDatabase => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::AccessSystemKey => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::ReadSystemKey => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::DebugDump => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::DebugRetryLogging(ref v) => fdb::fdb_transaction_set_option(
target,
code,
v.as_ptr() as *const u8,
v.len() as i32,
),
TransactionOption::TransactionLoggingEnable(ref v) => fdb::fdb_transaction_set_option(
target,
code,
v.as_ptr() as *const u8,
v.len() as i32,
),
TransactionOption::Timeout(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_transaction_set_option(target, code, data.as_ptr() as *const u8, 8)
}
TransactionOption::RetryLimit(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_transaction_set_option(target, code, data.as_ptr() as *const u8, 8)
}
TransactionOption::MaxRetryDelay(v) => {
let data: [u8; 8] = std::mem::transmute(v as i64);
fdb::fdb_transaction_set_option(target, code, data.as_ptr() as *const u8, 8)
}
TransactionOption::SnapshotRywEnable => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::SnapshotRywDisable => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::LockAware => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::UsedDuringCommitProtectionDisable => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
TransactionOption::ReadLockAware => {
fdb::fdb_transaction_set_option(target, code, std::ptr::null(), 0)
}
};
if err != 0 {
Err(error::Error::from(err))
} else {
Ok(())
}
}
}
#[derive(Clone, Copy, Debug)]
pub enum StreamingMode {
/// Client intends to consume the entire range and would like it all transferred as early as possible.
WantAll,
/// The default. The client doesn't know how much of the range it is likely to used and wants different performance concerns to be balanced. Only a small portion of data is transferred to the client initially (in order to minimize costs if the client doesn't read the entire range), and as the caller iterates over more items in the range larger batches will be transferred in order to minimize latency.
Iterator,
/// Infrequently used. The client has passed a specific row limit and wants that many rows delivered in a single batch. Because of iterator operation in client drivers make request batches transparent to the user, consider ``WANT_ALL`` StreamingMode instead. A row limit must be specified if this mode is used.
Exact,
/// Infrequently used. Transfer data in batches small enough to not be much more expensive than reading individual rows, to minimize cost if iteration stops early.
Small,
/// Infrequently used. Transfer data in batches sized in between small and large.
Medium,
/// Infrequently used. Transfer data in batches large enough to be, in a high-concurrency environment, nearly as efficient as possible. If the client stops iteration early, some disk and network bandwidth may be wasted. The batch size may still be too small to allow a single client to get high throughput from the database, so if that is what you need consider the SERIAL StreamingMode.
Large,
/// Transfer data in batches large enough that an individual client can get reasonable read bandwidth from the database. If the client stops iteration early, considerable disk and network bandwidth may be wasted.
Serial,
}
impl StreamingMode {
pub fn code(&self) -> fdb::FDBStreamingMode {
match *self {
StreamingMode::WantAll => fdb::FDBStreamingMode_FDB_STREAMING_MODE_WANT_ALL,
StreamingMode::Iterator => fdb::FDBStreamingMode_FDB_STREAMING_MODE_ITERATOR,
StreamingMode::Exact => fdb::FDBStreamingMode_FDB_STREAMING_MODE_EXACT,
StreamingMode::Small => fdb::FDBStreamingMode_FDB_STREAMING_MODE_SMALL,
StreamingMode::Medium => fdb::FDBStreamingMode_FDB_STREAMING_MODE_MEDIUM,
StreamingMode::Large => fdb::FDBStreamingMode_FDB_STREAMING_MODE_LARGE,
StreamingMode::Serial => fdb::FDBStreamingMode_FDB_STREAMING_MODE_SERIAL,
}
}
}
#[derive(Clone, Copy, Debug)]
pub enum MutationType {
/// addend
///
/// Performs an addition of little-endian integers. If the existing value in the database is not present or shorter than ``param``, it is first extended to the length of ``param`` with zero bytes. If ``param`` is shorter than the existing value in the database, the existing value is truncated to match the length of ``param``. The integers to be added must be stored in a little-endian representation. They can be signed in two's complement representation or unsigned. You can add to an integer at a known offset in the value by prepending the appropriate number of zero bytes to ``param`` and padding with zero bytes to match the length of the value. However, this offset technique requires that you know the addition will not cause the integer field within the value to overflow.
Add,
/// value with which to perform bitwise and
///
/// Deprecated
And,
/// value with which to perform bitwise and
///
/// Performs a bitwise ``and`` operation. If the existing value in the database is not present, then ``param`` is stored in the database. If the existing value in the database is shorter than ``param``, it is first extended to the length of ``param`` with zero bytes. If ``param`` is shorter than the existing value in the database, the existing value is truncated to match the length of ``param``.
BitAnd,
/// value with which to perform bitwise or
///
/// Deprecated
Or,
/// value with which to perform bitwise or
///
/// Performs a bitwise ``or`` operation. If the existing value in the database is not present or shorter than ``param``, it is first extended to the length of ``param`` with zero bytes. If ``param`` is shorter than the existing value in the database, the existing value is truncated to match the length of ``param``.
BitOr,
/// value with which to perform bitwise xor
///
/// Deprecated
Xor,
/// value with which to perform bitwise xor
///
/// Performs a bitwise ``xor`` operation. If the existing value in the database is not present or shorter than ``param``, it is first extended to the length of ``param`` with zero bytes. If ``param`` is shorter than the existing value in the database, the existing value is truncated to match the length of ``param``.
BitXor,
/// value to check against database value
///
/// Performs a little-endian comparison of byte strings. If the existing value in the database is not present or shorter than ``param``, it is first extended to the length of ``param`` with zero bytes. If ``param`` is shorter than the existing value in the database, the existing value is truncated to match the length of ``param``. The larger of the two values is then stored in the database.
Max,
/// value to check against database value
///
/// Performs a little-endian comparison of byte strings. If the existing value in the database is not present, then ``param`` is stored in the database. If the existing value in the database is shorter than ``param``, it is first extended to the length of ``param`` with zero bytes. If ``param`` is shorter than the existing value in the database, the existing value is truncated to match the length of ``param``. The smaller of the two values is then stored in the database.
Min,
/// value to which to set the transformed key
///
/// Transforms ``key`` using a versionstamp for the transaction. Sets the transformed key in the database to ``param``. A versionstamp is a 10 byte, unique, monotonically (but not sequentially) increasing value for each committed transaction. The first 8 bytes are the committed version of the database. The last 2 bytes are monotonic in the serialization order for transactions. WARNING: At this time versionstamps are compatible with the Tuple layer only in the Java and Python bindings. Note that this implies versionstamped keys may not be used with the Subspace and Directory layers except in those languages.
SetVersionstampedKey,
/// value to versionstamp and set
///
/// Transforms ``param`` using a versionstamp for the transaction. Sets ``key`` in the database to the transformed parameter. A versionstamp is a 10 byte, unique, monotonically (but not sequentially) increasing value for each committed transaction. The first 8 bytes are the committed version of the database. The last 2 bytes are monotonic in the serialization order for transactions. WARNING: At this time versionstamped values are not compatible with the Tuple layer.
SetVersionstampedValue,
/// value to check against database value
///
/// Performs lexicographic comparison of byte strings. If the existing value in the database is not present, then ``param`` is stored. Otherwise the smaller of the two values is then stored in the database.
ByteMin,
/// value to check against database value
///
/// Performs lexicographic comparison of byte strings. If the existing value in the database is not present, then ``param`` is stored. Otherwise the larger of the two values is then stored in the database.
ByteMax,
}
impl MutationType {
pub fn code(&self) -> fdb::FDBMutationType {
match *self {
MutationType::Add => fdb::FDBMutationType_FDB_MUTATION_TYPE_ADD,
MutationType::And => fdb::FDBMutationType_FDB_MUTATION_TYPE_AND,
MutationType::BitAnd => fdb::FDBMutationType_FDB_MUTATION_TYPE_BIT_AND,
MutationType::Or => fdb::FDBMutationType_FDB_MUTATION_TYPE_OR,
MutationType::BitOr => fdb::FDBMutationType_FDB_MUTATION_TYPE_BIT_OR,
MutationType::Xor => fdb::FDBMutationType_FDB_MUTATION_TYPE_XOR,
MutationType::BitXor => fdb::FDBMutationType_FDB_MUTATION_TYPE_BIT_XOR,
MutationType::Max => fdb::FDBMutationType_FDB_MUTATION_TYPE_MAX,
MutationType::Min => fdb::FDBMutationType_FDB_MUTATION_TYPE_MIN,
MutationType::SetVersionstampedKey => {
fdb::FDBMutationType_FDB_MUTATION_TYPE_SET_VERSIONSTAMPED_KEY
}
MutationType::SetVersionstampedValue => {
fdb::FDBMutationType_FDB_MUTATION_TYPE_SET_VERSIONSTAMPED_VALUE
}
MutationType::ByteMin => fdb::FDBMutationType_FDB_MUTATION_TYPE_BYTE_MIN,
MutationType::ByteMax => fdb::FDBMutationType_FDB_MUTATION_TYPE_BYTE_MAX,
}
}
}
#[derive(Clone, Copy, Debug)]
pub enum ConflictRangeType {
/// Used to add a read conflict range
Read,
/// Used to add a write conflict range
Write,
}
impl ConflictRangeType {
pub fn code(&self) -> fdb::FDBConflictRangeType {
match *self {
ConflictRangeType::Read => fdb::FDBConflictRangeType_FDB_CONFLICT_RANGE_TYPE_READ,
ConflictRangeType::Write => fdb::FDBConflictRangeType_FDB_CONFLICT_RANGE_TYPE_WRITE,
}
}
}
#[derive(Clone, Copy, Debug)]
pub enum ErrorPredicate {
/// Returns ``true`` if the error indicates the operations in the transactions should be retried because of transient error.
Retryable,
/// Returns ``true`` if the error indicates the transaction may have succeeded, though not in a way the system can verify.
MaybeCommitted,
/// Returns ``true`` if the error indicates the transaction has not committed, though in a way that can be retried.
RetryableNotCommitted,
}
impl ErrorPredicate {
pub fn code(&self) -> fdb::FDBErrorPredicate {
match *self {
ErrorPredicate::Retryable => fdb::FDBErrorPredicate_FDB_ERROR_PREDICATE_RETRYABLE,
ErrorPredicate::MaybeCommitted => {
fdb::FDBErrorPredicate_FDB_ERROR_PREDICATE_MAYBE_COMMITTED
}
ErrorPredicate::RetryableNotCommitted => {
fdb::FDBErrorPredicate_FDB_ERROR_PREDICATE_RETRYABLE_NOT_COMMITTED
}
}
}
}