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
// Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0. //! Iteration over engines and snapshots. //! //! For the purpose of key/value iteration, TiKV defines its own `Iterator` //! trait, and `Iterable` types that can create iterators. //! //! Both `KvEngine`s and `Snapshot`s are `Iterable`. //! //! Iteration is performed over consistent views into the database, even when //! iterating over the engine without creating a `Snapshot`. That is, iterating //! over an engine behaves implicitly as if a snapshot was created first, and //! the iteration is being performed on the snapshot. //! //! Iterators can be in an _invalid_ state, in which they are not positioned at //! a key/value pair. This can occur when attempting to move before the first //! pair, past the last pair, or when seeking to a key that does not exist. //! There may be other conditions that invalidate iterators (TODO: I don't //! know). //! //! An invalid iterator cannot move forward or back, but may be returned to a //! valid state through a successful "seek" operation. //! //! As TiKV inherits its iteration semantics from RocksDB, //! the RocksDB documentation is the ultimate reference: //! //! - [RocksDB iterator API](https://github.com/facebook/rocksdb/blob/master/include/rocksdb/iterator.h). //! - [RocksDB wiki on iterators](https://github.com/facebook/rocksdb/wiki/Iterator) use tikv_util::keybuilder::KeyBuilder; use crate::*; /// A token indicating where an iterator "seek" operation should stop. pub enum SeekKey<'a> { Start, End, Key(&'a [u8]), } /// An iterator over a consistent set of keys and values. /// /// Iterators are implemented for `KvEngine`s and for `Snapshot`s. They see a /// consistent view of the database; an iterator created by an engine behaves as /// if a snapshot was created first, and the iterator created from the snapshot. /// /// Most methods on iterators will panic if they are not "valid", /// as determined by the `valid` method. /// An iterator is valid if it is currently "pointing" to a key/value pair. /// /// Iterators begin in an invalid state; one of the `seek` methods /// must be called before beginning iteration. /// Iterators may become invalid after a failed `seek`, /// or after iteration has ended after calling `next` or `prev`, /// and they return `false`. pub trait Iterator: Send { /// Move the iterator to a specific key. /// /// When `key` is `SeekKey::Start` or `SeekKey::End`, /// `seek` and `seek_for_prev` behave identically. /// The difference between the two functions is how they /// behave for `SeekKey::Key`, and only when an exactly /// matching keys is not found: /// /// When seeking with `SeekKey::Key`, and an exact match is not found, /// `seek` sets the iterator to the next key greater than that /// specified as `key`, if such a key exists; /// `seek_for_prev` sets the iterator to the previous key less than /// that specified as `key`, if such a key exists. /// /// # Returns /// /// `true` if seeking succeeded and the iterator is valid, /// `false` if seeking failed and the iterator is invalid. fn seek(&mut self, key: SeekKey) -> Result<bool>; /// Move the iterator to a specific key. /// /// For the difference between this method and `seek`, /// see the documentation for `seek`. /// /// # Returns /// /// `true` if seeking succeeded and the iterator is valid, /// `false` if seeking failed and the iterator is invalid. fn seek_for_prev(&mut self, key: SeekKey) -> Result<bool>; /// Short for `seek(SeekKey::Start)`. fn seek_to_first(&mut self) -> Result<bool> { self.seek(SeekKey::Start) } /// Short for `seek(SeekKey::End)`. fn seek_to_last(&mut self) -> Result<bool> { self.seek(SeekKey::End) } /// Move a valid iterator to the previous key. /// /// # Panics /// /// If the iterator is invalid fn prev(&mut self) -> Result<bool>; /// Move a valid iterator to the next key. /// /// # Panics /// /// If the iterator is invalid fn next(&mut self) -> Result<bool>; /// Retrieve the current key. /// /// # Panics /// /// If the iterator is invalid fn key(&self) -> &[u8]; /// Retrieve the current value. /// /// # Panics /// /// If the iterator is invalid fn value(&self) -> &[u8]; /// Returns `true` if the iterator points to a `key`/`value` pair. fn valid(&self) -> Result<bool>; } pub trait Iterable { type Iterator: Iterator; fn iterator_opt(&self, opts: IterOptions) -> Result<Self::Iterator>; fn iterator_cf_opt(&self, cf: &str, opts: IterOptions) -> Result<Self::Iterator>; fn iterator(&self) -> Result<Self::Iterator> { self.iterator_opt(IterOptions::default()) } fn iterator_cf(&self, cf: &str) -> Result<Self::Iterator> { self.iterator_cf_opt(cf, IterOptions::default()) } fn scan<F>(&self, start_key: &[u8], end_key: &[u8], fill_cache: bool, f: F) -> Result<()> where F: FnMut(&[u8], &[u8]) -> Result<bool>, { let start = KeyBuilder::from_slice(start_key, DATA_KEY_PREFIX_LEN, 0); let end = KeyBuilder::from_slice(end_key, DATA_KEY_PREFIX_LEN, 0); let iter_opt = IterOptions::new(Some(start), Some(end), fill_cache); scan_impl(self.iterator_opt(iter_opt)?, start_key, f) } // like `scan`, only on a specific column family. fn scan_cf<F>( &self, cf: &str, start_key: &[u8], end_key: &[u8], fill_cache: bool, f: F, ) -> Result<()> where F: FnMut(&[u8], &[u8]) -> Result<bool>, { let start = KeyBuilder::from_slice(start_key, DATA_KEY_PREFIX_LEN, 0); let end = KeyBuilder::from_slice(end_key, DATA_KEY_PREFIX_LEN, 0); let iter_opt = IterOptions::new(Some(start), Some(end), fill_cache); scan_impl(self.iterator_cf_opt(cf, iter_opt)?, start_key, f) } // Seek the first key >= given key, if not found, return None. fn seek(&self, key: &[u8]) -> Result<Option<(Vec<u8>, Vec<u8>)>> { let mut iter = self.iterator()?; if iter.seek(SeekKey::Key(key))? { let (k, v) = (iter.key().to_vec(), iter.value().to_vec()); return Ok(Some((k, v))); } Ok(None) } // Seek the first key >= given key, if not found, return None. fn seek_cf(&self, cf: &str, key: &[u8]) -> Result<Option<(Vec<u8>, Vec<u8>)>> { let mut iter = self.iterator_cf(cf)?; if iter.seek(SeekKey::Key(key))? { return Ok(Some((iter.key().to_vec(), iter.value().to_vec()))); } Ok(None) } } fn scan_impl<Iter, F>(mut it: Iter, start_key: &[u8], mut f: F) -> Result<()> where Iter: Iterator, F: FnMut(&[u8], &[u8]) -> Result<bool>, { let mut remained = it.seek(SeekKey::Key(start_key))?; while remained { remained = f(it.key(), it.value())? && it.next()?; } Ok(()) } impl<'a> From<&'a [u8]> for SeekKey<'a> { fn from(bs: &'a [u8]) -> SeekKey { SeekKey::Key(bs) } } /// Collect all items of `it` into a vector, generally used for tests. /// /// # Panics /// /// If any errors occur during iterator. pub fn collect<I: Iterator>(mut it: I) -> Vec<(Vec<u8>, Vec<u8>)> { let mut v = Vec::new(); let mut it_valid = it.valid().unwrap(); while it_valid { let kv = (it.key().to_vec(), it.value().to_vec()); v.push(kv); it_valid = it.next().unwrap(); } v }