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
// Copyright 2014 Tyler Neely // // 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. // //! Rust wrapper for `RocksDB`. //! //! # Examples //! //! ```rust //! extern crate tempdir; //! extern crate exonum_rocksdb; //! //! use exonum_rocksdb::DB; //! use tempdir::TempDir; //! // NB: db is automatically closed at end of lifetime //! # fn main() { //! let temp_dir = TempDir::new("storage").unwrap(); //! let db = DB::open_default(temp_dir.path()).unwrap(); //! let _ = db.put(b"my key", b"my value"); //! match db.get(b"my key") { //! Ok(Some(value)) => println!("retrieved value {}", &value.to_utf8().unwrap()), //! Ok(None) => println!("value not found"), //! Err(e) => println!("operational problem encountered: {}", e), //! } //! db.delete(b"my key").unwrap(); //! # } //! ``` //! extern crate libc; extern crate exonum_librocksdb_sys as ffi; extern crate tempdir; #[macro_use] mod ffi_util; pub mod backup; mod comparator; pub mod merge_operator; pub mod compaction_filter; mod db; mod db_options; pub mod utils; pub use compaction_filter::Decision as CompactionDecision; pub use db::{DBCompactionStyle, DBCompressionType, DBIterator, DBRawIterator, DBRecoveryMode, DBVector, ReadOptions, Direction, IteratorMode, Snapshot, WriteBatch, new_bloom_filter}; pub use merge_operator::MergeOperands; use std::sync::{Arc, RwLock}; use std::collections::BTreeMap; use std::error; use std::fmt; use std::path::PathBuf; /// A `RocksDB` database. /// /// See crate level documentation for a simple usage example. pub struct DB { inner: *mut ffi::rocksdb_t, cfs: Arc<RwLock<BTreeMap<String, ColumnFamily>>>, path: PathBuf } /// A simple wrapper round a string, used for errors reported from /// ffi calls. #[derive(Debug, Clone, PartialEq)] pub struct Error { message: String } impl Error { fn new(message: String) -> Error { Error { message } } pub fn to_string(&self) -> String { self.message.clone() } } impl AsRef<str> for Error { fn as_ref(&self) -> &str { &self.message } } impl From<Error> for String { fn from(e: Error) -> String { e.message } } impl error::Error for Error { fn description(&self) -> &str { &self.message } } impl fmt::Display for Error { fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> { self.message.fmt(formatter) } } /// For configuring block-based file storage. pub struct BlockBasedOptions { inner: *mut ffi::rocksdb_block_based_table_options_t } /// Database-wide options around performance and behavior. /// /// Please read /// [the official tuning guide](https://github.com/facebook/rocksdb/wiki/RocksDB-Tuning-Guide), /// and most importantly, measure performance under realistic workloads with realistic hardware. /// /// # Examples /// /// ```rust /// use exonum_rocksdb::{Options, DB}; /// use exonum_rocksdb::DBCompactionStyle; /// /// fn badly_tuned_for_somebody_elses_disk() -> DB { /// let path = "path/for/rocksdb/storageX"; /// let mut opts = Options::default(); /// opts.create_if_missing(true); /// opts.set_max_open_files(10000); /// opts.set_use_fsync(false); /// opts.set_bytes_per_sync(8388608); /// opts.optimize_for_point_lookup(1024); /// opts.set_table_cache_num_shard_bits(6); /// opts.set_max_write_buffer_number(32); /// opts.set_write_buffer_size(536870912); /// opts.set_target_file_size_base(1073741824); /// opts.set_min_write_buffer_number_to_merge(4); /// opts.set_level_zero_stop_writes_trigger(2000); /// opts.set_level_zero_slowdown_writes_trigger(0); /// opts.set_compaction_style(DBCompactionStyle::Universal); /// opts.set_max_background_compactions(4); /// opts.set_max_background_flushes(4); /// opts.set_disable_auto_compactions(true); /// /// DB::open(&opts, path).unwrap() /// } /// ``` pub struct Options { inner: *mut ffi::rocksdb_options_t } /// Optionally disable WAL or sync for this write. /// /// # Examples /// /// Making an unsafe write of a batch: /// /// ```rust /// extern crate tempdir; /// extern crate exonum_rocksdb; /// /// use exonum_rocksdb::{DB, WriteBatch, WriteOptions}; /// use tempdir::TempDir; /// /// # fn main() { /// let temp_dir = TempDir::new("storageY").unwrap(); /// let db = DB::open_default(temp_dir.path()).unwrap(); /// /// let mut batch = WriteBatch::default(); /// batch.put(b"my key", b"my value"); /// batch.put(b"key2", b"value2"); /// batch.put(b"key3", b"value3"); /// /// let mut write_options = WriteOptions::default(); /// write_options.set_sync(false); /// write_options.disable_wal(true); /// /// db.write_opt(batch, &write_options); /// # } /// ``` pub struct WriteOptions { inner: *mut ffi::rocksdb_writeoptions_t } /// An opaque type used to represent a column family. Returned from some functions, and used /// in others #[derive(Copy, Clone)] pub struct ColumnFamily { inner: *mut ffi::rocksdb_column_family_handle_t }