heed/mdb/lmdb_flags.rs
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
use bitflags::bitflags;
use lmdb_master_sys as ffi;
bitflags! {
/// LMDB environment flags (see <http://www.lmdb.tech/doc/group__mdb__env.html> for more details).
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(transparent)]
pub struct EnvFlags: u32 {
/// mmap at a fixed address (experimental).
const FIXEDMAP = ffi::MDB_FIXEDMAP;
/// No environment directory.
const NO_SUB_DIR = ffi::MDB_NOSUBDIR;
/// Don't fsync after commit.
const NO_SYNC = ffi::MDB_NOSYNC;
/// Read only.
const READ_ONLY = ffi::MDB_RDONLY;
/// Don't fsync metapage after commit.
const NO_META_SYNC = ffi::MDB_NOMETASYNC;
/// Use writable mmap.
const WRITE_MAP = ffi::MDB_WRITEMAP;
/// Use asynchronous msync when MDB_WRITEMAP is used.
const MAP_ASYNC = ffi::MDB_MAPASYNC;
/// Tie reader locktable slots to MDB_txn objects instead of to threads.
const NO_TLS = ffi::MDB_NOTLS;
/// Don't do any locking, caller must manage their own locks.
const NO_LOCK = ffi::MDB_NOLOCK;
/// Don't do readahead (no effect on Windows).
const NO_READ_AHEAD = ffi::MDB_NORDAHEAD;
/// Don't initialize malloc'd memory before writing to datafile.
const NO_MEM_INIT = ffi::MDB_NOMEMINIT;
}
}
bitflags! {
/// LMDB database flags (see <http://www.lmdb.tech/doc/group__mdb__dbi__open.html> for more details).
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct AllDatabaseFlags: u32 {
/// Use reverse string keys.
const REVERSE_KEY = ffi::MDB_REVERSEKEY;
/// Use sorted duplicates.
const DUP_SORT = ffi::MDB_DUPSORT;
/// Numeric keys in native byte order: either `u32` or `usize`.
/// The keys must all be of the same size.
const INTEGER_KEY = ffi::MDB_INTEGERKEY;
/// With [`DatabaseFlags::DUP_SORT`], sorted dup items have fixed size.
const DUP_FIXED = ffi::MDB_DUPFIXED;
/// With [`DatabaseKey::DUP_SORT`], dups are [`DatabaseKey::INTEGER_KEY`]-style integers.
const INTEGER_DUP = ffi::MDB_INTEGERDUP;
/// With [`DatabaseKey::DUP_SORT`], use reverse string dups.
const REVERSE_DUP = ffi::MDB_REVERSEDUP;
/// Create DB if not already existing.
const CREATE = ffi::MDB_CREATE;
}
}
bitflags! {
/// LMDB database flags (see <http://www.lmdb.tech/doc/group__mdb__dbi__open.html> for more details).
// It is a subset of the whole list of possible flags LMDB exposes but
// we only want users to be able to specify these with the DUP flags.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct DatabaseFlags: u32 {
/// Use reverse string keys.
///
/// ```
/// # use std::fs;
/// # use std::path::Path;
/// # use heed::{DatabaseFlags, EnvOpenOptions};
/// use heed::types::*;
/// use heed::byteorder::BigEndian;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let dir = tempfile::tempdir()?;
/// # let env = unsafe { EnvOpenOptions::new()
/// # .map_size(10 * 1024 * 1024) // 10MB
/// # .max_dbs(3000)
/// # .open(dir.path())?
/// # };
///
/// let mut wtxn = env.write_txn()?;
/// let db = env.database_options()
/// .types::<Str, Unit>()
/// .flags(DatabaseFlags::REVERSE_KEY)
/// .name("reverse-key")
/// .create(&mut wtxn)?;
///
/// # db.clear(&mut wtxn)?;
/// db.put(&mut wtxn, &"bonjour", &())?;
/// db.put(&mut wtxn, &"hello", &())?;
/// db.put(&mut wtxn, &"holla", &())?;
///
/// let mut iter = db.iter(&wtxn)?;
/// assert_eq!(iter.next().transpose()?, Some(("holla", ())));
/// assert_eq!(iter.next().transpose()?, Some(("hello", ())));
/// assert_eq!(iter.next().transpose()?, Some(("bonjour", ())));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// let mut iter = db.rev_iter(&wtxn)?;
/// assert_eq!(iter.next().transpose()?, Some(("bonjour", ())));
/// assert_eq!(iter.next().transpose()?, Some(("hello", ())));
/// assert_eq!(iter.next().transpose()?, Some(("holla", ())));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// wtxn.commit()?;
/// # Ok(()) }
/// ```
const REVERSE_KEY = ffi::MDB_REVERSEKEY;
/// Use sorted duplicates.
///
/// ```
/// # use std::fs;
/// # use std::path::Path;
/// # use heed::{DatabaseFlags, EnvOpenOptions};
/// use heed::types::*;
/// use heed::byteorder::BigEndian;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let dir = tempfile::tempdir()?;
/// # let env = unsafe { EnvOpenOptions::new()
/// # .map_size(10 * 1024 * 1024) // 10MB
/// # .max_dbs(3000)
/// # .open(dir.path())?
/// # };
/// type BEI64 = I64<BigEndian>;
///
/// let mut wtxn = env.write_txn()?;
/// let db = env.database_options()
/// .types::<BEI64, BEI64>()
/// .flags(DatabaseFlags::DUP_SORT)
/// .name("dup-sort")
/// .create(&mut wtxn)?;
///
/// # db.clear(&mut wtxn)?;
/// db.put(&mut wtxn, &68, &120)?;
/// db.put(&mut wtxn, &68, &121)?;
/// db.put(&mut wtxn, &68, &122)?;
/// db.put(&mut wtxn, &68, &123)?;
/// db.put(&mut wtxn, &92, &32)?;
/// db.put(&mut wtxn, &35, &120)?;
/// db.put(&mut wtxn, &0, &120)?;
/// db.put(&mut wtxn, &42, &120)?;
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.next().transpose()?, Some((68, 120)));
/// assert_eq!(iter.next().transpose()?, Some((68, 121)));
/// assert_eq!(iter.next().transpose()?, Some((68, 122)));
/// assert_eq!(iter.next().transpose()?, Some((68, 123)));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.last().transpose()?, Some((68, 123)));
///
/// assert!(db.delete_one_duplicate(&mut wtxn, &68, &121)?, "The entry must exist");
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.next().transpose()?, Some((68, 120)));
/// // No more (68, 121) returned here!
/// assert_eq!(iter.next().transpose()?, Some((68, 122)));
/// assert_eq!(iter.next().transpose()?, Some((68, 123)));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// wtxn.commit()?;
/// # Ok(()) }
/// ```
const DUP_SORT = ffi::MDB_DUPSORT;
/// Numeric keys in native byte order: either `u32` or `usize`.
/// The keys must all be of the same size.
///
/// ```
/// # use std::fs;
/// # use std::path::Path;
/// # use heed::{DatabaseFlags, EnvOpenOptions};
/// use heed::types::*;
/// use heed::byteorder::BigEndian;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let dir = tempfile::tempdir()?;
/// # let env = unsafe { EnvOpenOptions::new()
/// # .map_size(10 * 1024 * 1024) // 10MB
/// # .max_dbs(3000)
/// # .open(dir.path())?
/// # };
/// type BEI32 = I32<BigEndian>;
///
/// let mut wtxn = env.write_txn()?;
/// let db = env.database_options()
/// .types::<BEI32, BEI32>()
/// .flags(DatabaseFlags::INTEGER_KEY)
/// .name("integer-key")
/// .create(&mut wtxn)?;
///
/// # db.clear(&mut wtxn)?;
/// db.put(&mut wtxn, &68, &120)?;
/// db.put(&mut wtxn, &92, &32)?;
/// db.put(&mut wtxn, &35, &120)?;
/// db.put(&mut wtxn, &0, &120)?;
/// db.put(&mut wtxn, &42, &120)?;
///
/// let mut iter = db.iter(&wtxn)?;
/// assert_eq!(iter.next().transpose()?, Some((0, 120)));
/// assert_eq!(iter.next().transpose()?, Some((35, 120)));
/// assert_eq!(iter.next().transpose()?, Some((42, 120)));
/// assert_eq!(iter.next().transpose()?, Some((68, 120)));
/// assert_eq!(iter.next().transpose()?, Some((92, 32)));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// wtxn.commit()?;
/// # Ok(()) }
/// ```
const INTEGER_KEY = ffi::MDB_INTEGERKEY;
/// With [`DatabaseFlags::DUP_SORT`], sorted dup items have fixed size.
///
/// ```
/// # use std::fs;
/// # use std::path::Path;
/// # use heed::{DatabaseFlags, EnvOpenOptions};
/// use heed::types::*;
/// use heed::byteorder::BigEndian;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let dir = tempfile::tempdir()?;
/// # let env = unsafe { EnvOpenOptions::new()
/// # .map_size(10 * 1024 * 1024) // 10MB
/// # .max_dbs(3000)
/// # .open(dir.path())?
/// # };
/// type BEI64 = I64<BigEndian>;
///
/// let mut wtxn = env.write_txn()?;
/// let db = env.database_options()
/// .types::<BEI64, BEI64>()
/// .flags(DatabaseFlags::DUP_SORT | DatabaseFlags::DUP_FIXED)
/// .name("dup-sort-fixed")
/// .create(&mut wtxn)?;
///
/// # db.clear(&mut wtxn)?;
/// db.put(&mut wtxn, &68, &120)?;
/// db.put(&mut wtxn, &68, &121)?;
/// db.put(&mut wtxn, &68, &122)?;
/// db.put(&mut wtxn, &68, &123)?;
/// db.put(&mut wtxn, &92, &32)?;
/// db.put(&mut wtxn, &35, &120)?;
/// db.put(&mut wtxn, &0, &120)?;
/// db.put(&mut wtxn, &42, &120)?;
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.next().transpose()?, Some((68, 120)));
/// assert_eq!(iter.next().transpose()?, Some((68, 121)));
/// assert_eq!(iter.next().transpose()?, Some((68, 122)));
/// assert_eq!(iter.next().transpose()?, Some((68, 123)));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.last().transpose()?, Some((68, 123)));
///
/// assert!(db.delete_one_duplicate(&mut wtxn, &68, &121)?, "The entry must exist");
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.next().transpose()?, Some((68, 120)));
/// // No more (68, 121) returned here!
/// assert_eq!(iter.next().transpose()?, Some((68, 122)));
/// assert_eq!(iter.next().transpose()?, Some((68, 123)));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// wtxn.commit()?;
/// # Ok(()) }
/// ```
const DUP_FIXED = ffi::MDB_DUPFIXED;
/// With [`DatabaseKey::DUP_SORT`], dups are [`DatabaseKey::INTEGER_KEY`]-style integers.
///
/// ```
/// # use std::fs;
/// # use std::path::Path;
/// # use heed::{DatabaseFlags, EnvOpenOptions};
/// use heed::types::*;
/// use heed::byteorder::BigEndian;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let dir = tempfile::tempdir()?;
/// # let env = unsafe { EnvOpenOptions::new()
/// # .map_size(10 * 1024 * 1024) // 10MB
/// # .max_dbs(3000)
/// # .open(dir.path())?
/// # };
/// type BEI32 = I32<BigEndian>;
///
/// let mut wtxn = env.write_txn()?;
/// let db = env.database_options()
/// .types::<BEI32, BEI32>()
/// .flags(DatabaseFlags::DUP_SORT | DatabaseFlags::INTEGER_DUP)
/// .name("dup-sort-integer-dup")
/// .create(&mut wtxn)?;
///
/// # db.clear(&mut wtxn)?;
/// db.put(&mut wtxn, &68, &120)?;
/// db.put(&mut wtxn, &68, &121)?;
/// db.put(&mut wtxn, &68, &122)?;
/// db.put(&mut wtxn, &68, &123)?;
/// db.put(&mut wtxn, &92, &32)?;
/// db.put(&mut wtxn, &35, &120)?;
/// db.put(&mut wtxn, &0, &120)?;
/// db.put(&mut wtxn, &42, &120)?;
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.next().transpose()?, Some((68, 120)));
/// assert_eq!(iter.next().transpose()?, Some((68, 121)));
/// assert_eq!(iter.next().transpose()?, Some((68, 122)));
/// assert_eq!(iter.next().transpose()?, Some((68, 123)));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.last().transpose()?, Some((68, 123)));
///
/// assert!(db.delete_one_duplicate(&mut wtxn, &68, &121)?, "The entry must exist");
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.next().transpose()?, Some((68, 120)));
/// // No more (68, 121) returned here!
/// assert_eq!(iter.next().transpose()?, Some((68, 122)));
/// assert_eq!(iter.next().transpose()?, Some((68, 123)));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// wtxn.commit()?;
/// # Ok(()) }
/// ```
const INTEGER_DUP = ffi::MDB_INTEGERDUP;
/// With [`DatabaseKey::DUP_SORT`], use reverse string dups.
///
/// ```
/// # use std::fs;
/// # use std::path::Path;
/// # use heed::{DatabaseFlags, EnvOpenOptions};
/// use heed::types::*;
/// use heed::byteorder::BigEndian;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let dir = tempfile::tempdir()?;
/// # let env = unsafe { EnvOpenOptions::new()
/// # .map_size(10 * 1024 * 1024) // 10MB
/// # .max_dbs(3000)
/// # .open(dir.path())?
/// # };
/// type BEI64 = I64<BigEndian>;
///
/// let mut wtxn = env.write_txn()?;
/// let db = env.database_options()
/// .types::<BEI64, Str>()
/// .flags(DatabaseFlags::DUP_SORT | DatabaseFlags::REVERSE_DUP)
/// .name("dup-sort")
/// .create(&mut wtxn)?;
///
/// # db.clear(&mut wtxn)?;
/// db.put(&mut wtxn, &68, &"bonjour")?;
/// db.put(&mut wtxn, &68, &"holla")?;
/// db.put(&mut wtxn, &68, &"hello")?;
/// db.put(&mut wtxn, &92, &"hallo")?;
///
/// let mut iter = db.get_duplicates(&wtxn, &68)?.expect("the key exists");
/// assert_eq!(iter.next().transpose()?, Some((68, "holla")));
/// assert_eq!(iter.next().transpose()?, Some((68, "hello")));
/// assert_eq!(iter.next().transpose()?, Some((68, "bonjour")));
/// assert_eq!(iter.next().transpose()?, None);
/// drop(iter);
///
/// wtxn.commit()?;
/// # Ok(()) }
/// ```
const REVERSE_DUP = ffi::MDB_REVERSEDUP;
}
}
bitflags! {
/// LMDB put flags (see <http://www.lmdb.tech/doc/group__mdb.html#ga4fa8573d9236d54687c61827ebf8cac0>
/// or <http://www.lmdb.tech/doc/group__mdb.html#ga1f83ccb40011837ff37cc32be01ad91e> for more details).
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct PutFlags: u32 {
/// Enter the new key/data pair only if it does not already appear in the database.
///
/// This flag may only be specified if the database was opened with MDB_DUPSORT.
/// The function will return MDB_KEYEXIST if the key/data pair already appears in the database.
const NO_DUP_DATA = ffi::MDB_NODUPDATA;
/// Enter the new key/data pair only if the key does not already appear in the database.
///
/// The function will return MDB_KEYEXIST if the key already appears in the database,
/// even if the database supports duplicates (MDB_DUPSORT).
/// The data parameter will be set to point to the existing item.
const NO_OVERWRITE = ffi::MDB_NOOVERWRITE;
/// Append the given key/data pair to the end of the database.
///
/// This option allows fast bulk loading when keys are already known to be in the correct order.
/// Loading unsorted keys with this flag will cause a MDB_KEYEXIST error.
const APPEND = ffi::MDB_APPEND;
/// Append the given key/data pair to the end of the database but for sorted dup data.
///
/// This option allows fast bulk loading when keys and dup data are already known to be in the correct order.
/// Loading unsorted key/values with this flag will cause a MDB_KEYEXIST error.
const APPEND_DUP = ffi::MDB_APPENDDUP;
}
}