dist/api_flags

   1 db_env_create
   2         DB_CXX_NO_EXCEPTIONS            # C++: return error values
   3         DB_RPCCLIENT                    # An RPC client environment
   4
   5 DbEnv.dbremove
   6         DB_AUTO_COMMIT                  # Implied transaction
   7         DB_TXN_NOT_DURABLE              # Don't log the remove
   8
   9 DbEnv.dbrename
  10         DB_AUTO_COMMIT                  # Implied transaction
  11
  12 DbEnv.fileid_reset
  13         DB_ENCRYPT                      # File contains encrypted databases
  14
  15 DbEnv.open
  16         DB_CREATE                       # Create as necessary
  17         DB_FAILCHK                      # Run failchk on open
  18         DB_INIT_CDB                     # Concurrent Access Methods
  19         DB_INIT_LOCK                    # Initialize locking
  20         DB_INIT_LOG                     # Initialize logging
  21         DB_INIT_MPOOL                   # Initialize mpool
  22         DB_INIT_REP                     # Initialize replication
  23         DB_INIT_TXN                     # Initialize transactions
  24         DB_LOCKDOWN                     # Lock memory into physical core
  25         DB_PRIVATE                      # DB_ENV is process local
  26         DB_RECOVER                      # Run normal recovery
  27         DB_RECOVER_FATAL                # Run catastrophic recovery
  28         DB_REGISTER                     # Multi-process registry
  29         DB_SYSTEM_MEM                   # Use system-backed memory
  30         DB_THREAD                       # Handle is free-threaded
  31         DB_USE_ENVIRON                  # Use the environment
  32         DB_USE_ENVIRON_ROOT             # Use the environment if root
  33
  34 DbEnv.lock_stat
  35         DB_STAT_CLEAR                   # Clear stats after return
  36
  37 DbEnv.lock_stat_print
  38         DB_STAT_ALL                     # Everything
  39         DB_STAT_CLEAR                   # Clear stats after return
  40         DB_STAT_LOCK_CONF               # Print lock conflict matrix
  41         DB_STAT_LOCK_LOCKERS            # Print lockers
  42         DB_STAT_LOCK_OBJECTS            # Print lock objects
  43         DB_STAT_LOCK_PARAMS             # Print lock parameters
  44         DB_STAT_SUBSYSTEM               # Print subsystems
  45
  46 DbEnv.lock_vec
  47         DB_LOCK_NOWAIT                  # Don't wait for an unavailable lock
  48         DB_LOCK_RECORD                  # UNDOC: record lock
  49         DB_LOCK_SET_TIMEOUT             # UNDOC: set lock timeout
  50         DB_LOCK_SWITCH                  # UNDOC: switch existing lock
  51         DB_LOCK_UPGRADE                 # UNDOC: upgrade existing lock
  52
  53 DbEnv.log_archive
  54         DB_ARCH_ABS                     # Absolute pathnames
  55         DB_ARCH_DATA                    # Data files
  56         DB_ARCH_LOG                     # Log files
  57         DB_ARCH_REMOVE                  # Remove log files
  58
  59 DbEnv.log_put
  60         DB_FLUSH                        # Flush data to disk
  61         DB_LOG_CHKPNT                   # UNDOC: Flush supports a checkpoint
  62         DB_LOG_COMMIT                   # UNDOC: Flush supports a commit
  63         DB_LOG_NOCOPY                   # UNDOC: Don't copy data
  64         DB_LOG_NOT_DURABLE              # UNDOC: Do not log; keep in memory
  65         DB_LOG_WRNOSYNC                 # UNDOC: Write, don't sync log_put
  66
  67 DbEnv.log_set_config
  68         DB_LOG_DIRECT                   # Don't buffer log files in the OS
  69         DB_LOG_DSYNC                    # Set O_DSYNC on the log
  70         DB_LOG_AUTO_REMOVE              # Automatically remove log files
  71         DB_LOG_IN_MEMORY                # Store logs in buffers in memory
  72         DB_LOG_ZERO                     # Zero log file on creation
  73
  74 DbEnv.log_stat
  75         DB_STAT_CLEAR                   # Clear stats after return
  76
  77 DbEnv.log_stat_print
  78         DB_STAT_ALL                     # Everything
  79         DB_STAT_CLEAR                   # Clear stats after return
  80         DB_STAT_SUBSYSTEM               # Print subsystems
  81
  82 DbEnv.lsn_reset
  83         DB_ENCRYPT                      # File contains encrypted databases
  84
  85 DbEnv.memp_stat
  86         DB_STAT_CLEAR                   # Clear stats after return
  87
  88 DbEnv.memp_stat_print
  89         DB_STAT_ALL                     # Everything
  90         DB_STAT_CLEAR                   # Clear stats after return
  91         DB_STAT_MEMP_HASH               # Print mpool hash buckets
  92         DB_STAT_MEMP_NOERROR            # UNDOC: continue on error
  93         DB_STAT_SUBSYSTEM               # Print subsystems
  94
  95 DbEnv.mutex_alloc
  96         DB_MUTEX_ALLOCATED              # UNDOC: Mutex currently allocated
  97         DB_MUTEX_LOCKED                 # UNDOC: Mutex currently locked
  98         DB_MUTEX_LOGICAL_LOCK           # UNDOC: Mutex backs a database lock
  99         DB_MUTEX_PROCESS_ONLY           # Mutex private to a process
 100         DB_MUTEX_SELF_BLOCK             # Must be able to block self
 101         DB_MUTEX_SHARED                 # Shared (read/write) mutex
 102
 103 DbEnv.mutex_stat
 104         DB_STAT_CLEAR                   # Clear stats after return
 105
 106 DbEnv.mutex_stat_print
 107         DB_STAT_ALL                     # Everything
 108         DB_STAT_CLEAR                   # Clear stats after return
 109         DB_STAT_SUBSYSTEM               # Print subsystems
 110
 111 DbEnv.remove
 112         DB_FORCE
 113         DB_USE_ENVIRON                  # Use the environment
 114         DB_USE_ENVIRON_ROOT             # Use the environment if root
 115
 116 DbEnv.rep_set_config
 117         DB_REPMGR_CONF_2SITE_STRICT     # Don't cheat on election votes
 118         DB_REP_CONF_BULK                # Bulk transfer
 119         DB_REP_CONF_DELAYCLIENT         # Delay client synchronization
 120         DB_REP_CONF_INMEM               # In-memory replication
 121         DB_REP_CONF_LEASE               # Master leases
 122         DB_REP_CONF_NOAUTOINIT          # No automatic client init
 123         DB_REP_CONF_NOWAIT              # Don't wait, return error
 124
 125 DbEnv.rep_set_transport
 126         DB_REP_ANYWHERE                 # Message can be serviced anywhere
 127         DB_REP_NOBUFFER                 # Do not buffer this message
 128         DB_REP_PERMANENT                # Important -- app may want to flush
 129         DB_REP_REREQUEST                # This msg already been requested
 130
 131 DbEnv.rep_start
 132         DB_REP_CLIENT                   # Client
 133         DB_REP_MASTER                   # Master
 134
 135 DbEnv.rep_stat
 136         DB_STAT_CLEAR                   # Clear stats after return
 137
 138 DbEnv.rep_stat_print
 139         DB_STAT_ALL                     # Everything
 140         DB_STAT_CLEAR                   # Clear stats after return
 141         DB_STAT_SUBSYSTEM               # Print subsystems
 142
 143 DbEnv.repmgr_add_remote_site
 144         DB_REPMGR_PEER                  # C2C synchronization
 145
 146 DbEnv.repmgr_start
 147         DB_REP_CLIENT                   # Client
 148         DB_REP_ELECTION                 # Election
 149         DB_REP_MASTER                   # Master
 150
 151 DbEnv.repmgr_stat
 152         DB_STAT_CLEAR                   # Clear stats after return
 153
 154 DbEnv.repmgr_stat_print
 155         DB_STAT_ALL                     # Everything
 156         DB_STAT_CLEAR                   # Clear stats after return
 157         DB_STAT_SUBSYSTEM               # Print subsystems
 158
 159 DbEnv.set_encrypt
 160         DB_ENCRYPT_AES                  # AES, assumes SHA1 checksum
 161
 162 DbEnv.set_feedback.op
 163         DB_RECOVER                      # Running recovery.
 164
 165 DbEnv.set_flags
 166         DB_AUTO_COMMIT                  # Implied transaction
 167         DB_CDB_ALLDB                    # Set CDB locking per environment
 168         DB_DIRECT_DB                    # Don't buffer databases in the OS
 169         DB_DSYNC_DB                     # Set O_DSYNC on the databases
 170         DB_MULTIVERSION                 # Multiversion concurrency control
 171         DB_NOLOCKING                    # Set locking/mutex behavior
 172         DB_NOMMAP                       # Don't mmap the underlying file
 173         DB_NOPANIC                      # Set panic state per environment
 174         DB_OVERWRITE                    # Overwrite unlinked region files
 175         DB_PANIC_ENVIRONMENT            # Set panic state per environment
 176         DB_REGION_INIT                  # Page-fault regions on open
 177         DB_TIME_NOTGRANTED              # Return NOTGRANTED on timeout
 178         DB_TXN_NOSYNC                   # Do not sync log on commit
 179         DB_TXN_NOWAIT                   # Do not wait for locks
 180         DB_TXN_SNAPSHOT                 # Snapshot isolation
 181         DB_TXN_WRITE_NOSYNC             # Write the log bug don't sync
 182         DB_YIELDCPU                     # Yield the CPU (a lot)
 183
 184 DbEnv.set_isalive
 185         DB_MUTEX_ALLOCATED              # UNDOC: Mutex currently allocated
 186         DB_MUTEX_LOCKED                 # UNDOC: Mutex currently locked
 187         DB_MUTEX_LOGICAL_LOCK           # UNDOC: Mutex backs a database lock
 188         DB_MUTEX_PROCESS_ONLY           # Mutex private to a process
 189         DB_MUTEX_SELF_BLOCK             # Must be able to block self
 190
 191 DbEnv.set_timeout
 192         DB_SET_LOCK_TIMEOUT             # Set lock timeout
 193         DB_SET_TXN_NOW                  # UNDOC: Timeout lock now
 194         DB_SET_TXN_TIMEOUT              # Set transaction timeout
 195         DB_SET_REG_TIMEOUT              # Set dbregister timeout
 196
 197 DbEnv.set_verbose
 198         DB_VERB_DEADLOCK                # Deadlock detection information
 199         DB_VERB_FILEOPS                 # Major file operations
 200         DB_VERB_FILEOPS_ALL             # All file operations
 201         DB_VERB_RECOVERY                # Recovery information
 202         DB_VERB_REGISTER                # Dump waits-for table
 203         DB_VERB_REPLICATION             # All replication and repmgr output
 204         DB_VERB_REPMGR_CONNFAIL         # Repmgr connection failure output
 205         DB_VERB_REPMGR_MISC             # Miscellaneous repmgr output
 206         DB_VERB_REP_ELECT               # Replication election output
 207         DB_VERB_REP_LEASE               # Replication master lease output
 208         DB_VERB_REP_MISC                # Miscellaneous replication output
 209         DB_VERB_REP_MSGS                # Replication message output
 210         DB_VERB_REP_SYNC                # Replication client sync output
 211         DB_VERB_REP_TEST                # Replication temporary test output
 212         DB_VERB_WAITSFOR                # Dump waits-for table
 213
 214 DbEnv.stat_print
 215         DB_STAT_ALL                     # Everything
 216         DB_STAT_CLEAR                   # Clear stats after return
 217         DB_STAT_SUBSYSTEM               # Print subsystems
 218
 219 DbEnv.txn_begin
 220         DB_READ_COMMITTED               # Degree 2 isolation
 221         DB_READ_UNCOMMITTED             # Degree 1 isolation
 222         DB_TXN_NOSYNC                   # Do not sync log on commit
 223         DB_TXN_NOWAIT                   # Do not wait for locks
 224         DB_TXN_SNAPSHOT                 # Snapshot isolation
 225         DB_TXN_SYNC                     # Always sync log on commit
 226         DB_TXN_WAIT                     # Always wait for locks in this txn
 227         DB_TXN_WRITE_NOSYNC             # Write the log but don't sync
 228
 229 DbEnv.txn_checkpoint
 230         DB_CKP_INTERNAL                 # UNDOC: internally generated checkpoint
 231         DB_FORCE                        # Force
 232
 233 DbEnv.txn_recover
 234         __MASK=0xff                     # Berkeley DB operation codes.
 235
 236 DbEnv.txn_stat
 237         DB_STAT_CLEAR                   # Clear stats after return
 238
 239 DbEnv.txn_stat_print
 240         DB_STAT_ALL                     # Everything
 241         DB_STAT_CLEAR                   # Clear stats after return
 242         DB_STAT_SUBSYSTEM               # Print subsystems
 243
 244 DbLogc.get
 245         __MASK=0xff                     # Berkeley DB operation codes.
 246
 247 DbMpoolFile.close
 248         DB_MPOOL_DISCARD                # UNDOC: Discard file
 249         DB_MPOOL_NOLOCK                 # UNDOC: Already have mpf locked
 250
 251 DbMpoolFile.get
 252         DB_MPOOL_CREATE                 # Create a page
 253         DB_MPOOL_DIRTY                  # Get page for an update
 254         DB_MPOOL_EDIT                   # Modify without copying
 255         DB_MPOOL_FREE                   # UNDOC: Free page if present
 256         DB_MPOOL_LAST                   # Return the last page
 257         DB_MPOOL_NEW                    # Create a new page
 258         DB_MPOOL_TRY                    # Try to read a page, but don't block
 259
 260 DbMpoolFile.open
 261         DB_CREATE                       # Create as necessary
 262         DB_DIRECT                       # Don't buffer the file in the OS
 263         DB_DURABLE_UNKNOWN              # UNDOC: Durability on open
 264         DB_EXTENT                       # UNDOC: dealing with an extent
 265         DB_MULTIVERSION                 # Multiversion concurrency control
 266         DB_NOMMAP                       # Don't mmap underlying file
 267         DB_ODDFILESIZE                  # Truncate file to N * pgsize
 268         DB_RDONLY                       # Read-only (O_RDONLY)
 269         DB_TXN_NOT_DURABLE              # UNDOC: Mark file not durable on open
 270
 271 DbMpoolFile.set_flags
 272         DB_MPOOL_NOFILE                 # Never open a backing file
 273         DB_MPOOL_UNLINK                 # Unlink the file on last close
 274
 275 DbSequence.get
 276         DB_AUTO_COMMIT                  # UNDOC: compatibility only
 277         DB_TXN_NOSYNC                   # Do not sync log on commit
 278
 279 DbSequence.open
 280         DB_AUTO_COMMIT                  # UNDOC: compatibility only
 281         DB_CREATE                       # Create as necessary
 282         DB_EXCL                         # Exclusive open (O_EXCL)
 283         DB_THREAD                       # Handle is free-threaded
 284
 285 DbSequence.remove
 286         DB_TXN_NOSYNC                   # Do not sync log on commit
 287
 288 DbSequence.set_flags
 289         DB_SEQ_DEC                      # Decrement sequence
 290         DB_SEQ_INC                      # Increment sequence
 291         DB_SEQ_RANGE_SET                # UNDOC: Range set
 292         DB_SEQ_WRAP                     # Wrap sequence at min/max
 293         DB_SEQ_WRAPPED                  # UNDOC: Just wrapped
 294
 295 DbSequence.stat
 296         DB_STAT_CLEAR                   # Clear stats after return
 297
 298 DbSequence.stat_print
 299         DB_STAT_CLEAR                   # Clear stats after return
 300         DB_STAT_SUBSYSTEM               # Print subsystems
 301
 302 DbTxn.commit
 303         DB_TXN_NOSYNC                   # Do not sync log on commit
 304         DB_TXN_SYNC                     # Always sync log on commit
 305
 306 DbTxn.set_timeout
 307         DB_SET_LOCK_TIMEOUT             # Set lock timeout
 308         DB_SET_TXN_TIMEOUT              # Set transaction timeout
 309
 310 db_create
 311         DB_CXX_NO_EXCEPTIONS            # C++: return error values
 312
 313 Db.associate
 314         DB_AUTO_COMMIT                  # UNDOC: compatibility only
 315         DB_CREATE                       # Create as necessary
 316         DB_IMMUTABLE_KEY                # Secondary key is immutable
 317
 318 Db.associate_foreign
 319         DB_FOREIGN_ABORT                # If foreign key exists, delete aborts
 320         DB_FOREIGN_CASCADE              # If foreign key exists, delete cascades
 321         DB_FOREIGN_NULLIFY              # If foreign key exists, nullify it
 322
 323 Db.close
 324         __MASK=0xff                     # Berkeley DB operation codes.
 325
 326 Db.compact
 327         DB_FREELIST_ONLY                # Just sort and truncate
 328         DB_FREE_SPACE                   # Free space
 329
 330 Db.cursor
 331         DB_CURSOR_BULK                  # Optimize for bulk updates
 332         DB_CURSOR_TRANSIENT             # UNDOC: Single-use cursor
 333         DB_READ_COMMITTED               # Degree 2 isolation
 334         DB_READ_UNCOMMITTED             # Degree 1 isolation
 335         DB_WRITECURSOR                  # Cursor can update (CDB)
 336         DB_WRITELOCK                    # Cursor should get write locks
 337         DB_TXN_SNAPSHOT                 # Snapshot isolation
 338
 339 Db.del
 340         DB_AUTO_COMMIT                  # UNDOC: compatibility only
 341         DB_MULTIPLE                     # Delete multiple data values
 342         DB_MULTIPLE_KEY                 # Delete multiple key/data pairs
 343
 344 Db.exists
 345         DB_READ_COMMITTED               # Degree 2 isolation
 346         DB_READ_UNCOMMITTED             # Degree 1 isolation
 347         DB_RMW                          # Acquire write lock immediately
 348
 349 Db.get
 350         __MASK=0xff                     # Berkeley DB operation codes.
 351         DB_AUTO_COMMIT                  # UNDOC: compatibility only
 352         DB_IGNORE_LEASE                 # Ignore leases
 353         DB_MULTIPLE                     # Return multiple data values
 354         DB_READ_COMMITTED               # Degree 2 isolation
 355         DB_READ_UNCOMMITTED             # Degree 1 isolation
 356         DB_RMW                          # Acquire write lock immediately
 357
 358 Db.pget
 359         __MASK=0xff                     # Berkeley DB operation codes.
 360         DB_IGNORE_LEASE                 # Ignore leases
 361         DB_MULTIPLE                     # Return multiple data values
 362         DB_READ_COMMITTED               # Degree 2 isolation
 363         DB_READ_UNCOMMITTED             # Degree 1 isolation
 364         DB_RMW                          # Acquire write lock immediately
 365
 366 Db.join
 367         DB_JOIN_NOSORT                  # Don't try to optmize join
 368
 369 Db.open
 370         DB_AUTO_COMMIT                  # Implied transaction
 371         DB_CREATE                       # Create file as necessary
 372         DB_EXCL                         # Exclusive open (O_EXCL)
 373         DB_FCNTL_LOCKING                # UNDOC: fcntl(2) locking
 374         DB_MULTIVERSION                 # Multiversion concurrency control
 375         DB_NOMMAP                       # Don't mmap underlying file
 376         DB_NO_AUTO_COMMIT               # UNDOC: override env's AUTO_COMMIT
 377         DB_RDONLY                       # Read-only (O_RDONLY)
 378         DB_RDWRMASTER                   # UNDOC: allow subdb master open R/W
 379         DB_READ_UNCOMMITTED             # Degree 1 isolation
 380         DB_THREAD                       # Handle is free-threaded
 381         DB_TRUNCATE                     # Discard existing DB (O_TRUNC)
 382
 383         # The following flags aren't actually part of the Db.open method
 384         # API, but they are accepted by the underlying __db_open function.
 385         DB_DURABLE_UNKNOWN              # UNDOC: Durability on open
 386         DB_ODDFILESIZE                  # UNDOC: Truncate file to N * pgsize
 387         DB_WRITEOPEN                    # UNDOC: open with write lock
 388
 389         # The following flags are DB constructor flags.  However, create and/or
 390         # open of BDB XML containers is done in a single call (rather than the
 391         # two-call "construct the object, then open it" paradigm used by DB),
 392         # and they can't collide for that reason.
 393         DB_CXX_NO_EXCEPTIONS            # C++: return error values
 394
 395 Db.put
 396         __MASK=0xff                     # Berkeley DB operation codes.
 397         DB_AUTO_COMMIT                  # UNDOC: compatibility only
 398         DB_MULTIPLE                     # Put multiple (from key and data DBTs)
 399         DB_MULTIPLE_KEY                 # Put multiple (from key DBT)
 400
 401 Db.set_encrypt
 402         DB_ENCRYPT_AES                  # AES, assumes SHA1 checksum
 403
 404 Db.set_feedback
 405         DB_UPGRADE                      # Upgrading
 406         DB_VERIFY                       # Verifying
 407
 408 Db.set_flags
 409         DB_CHKSUM                       # Checksums
 410         DB_DUP                          # Btree, Hash: duplicate keys
 411         DB_DUPSORT                      # Btree, Hash: sorted duplicated
 412         DB_ENCRYPT                      # AES, assumes SHA1 checksum
 413         DB_INORDER                      # Queue: strict ordering on consume
 414         DB_RECNUM                       # Btree: record numbers
 415         DB_RENUMBER                     # Recno: renumber on insert/delete
 416         DB_REVSPLITOFF                  # Btree: turn off reverse splits
 417         DB_SNAPSHOT                     # Recno: snapshot the input
 418         DB_TXN_NOT_DURABLE              # Do not log changes
 419
 420 Db.stat
 421         DB_FAST_STAT                    # Don't traverse the database
 422         DB_READ_COMMITTED               # Degree 2 isolation
 423         DB_READ_UNCOMMITTED             # Degree 1 isolation
 424
 425 Db.truncate
 426         DB_AUTO_COMMIT                  # UNDOC: compatibility only
 427
 428 Db.upgrade
 429         DB_DUPSORT                      # Upgrade duplicate data items
 430
 431 Db.verify
 432         DB_AGGRESSIVE                   # Salvage whatever could be data
 433         DB_NOORDERCHK                   # Skip sort order/hashing check
 434         DB_ORDERCHKONLY                 # Only perform the order check
 435         DB_PRINTABLE                    # Use printable format for salvage
 436         DB_PR_PAGE                      # UNDOC: Show page contents (-da)
 437         DB_PR_RECOVERYTEST              # UNDOC: Recover test (-dr)
 438         DB_SALVAGE                      # Salvage what looks like data
 439         DB_UNREF                        # UNDOC: Report unreferenced pages
 440         DB_VERIFY_PARTITION             # Verifying a partition
 441
 442         # Flags understood by the btree structure checks (__bam_vrfy_subtree).
 443         # These share the same space as the global flags to Db.verify.
 444         DB_ST_DUPOK                     # UNDOC: Duplicates are acceptable
 445         DB_ST_DUPSET                    # UNDOC: Subtree is in a duplicate tree
 446         DB_ST_DUPSORT                   # UNDOC: Duplicates are sorted
 447         DB_ST_IS_RECNO                  # UNDOC: Subtree is a recno
 448         DB_ST_OVFL_LEAF                 # UNDOC: Overflow reffed from leaf page
 449         DB_ST_RECNUM                    # UNDOC: Subtree has record numbering on
 450         DB_ST_RELEN                     # UNDOC: Subtree has fixed-length recs
 451         DB_ST_TOPLEVEL                  # UNDOC: Subtree == entire tree
 452
 453         # Flags understood by __bam_salvage and __db_salvage.  These need not
 454         # share name space with the __bam_vrfy_subtree flags, but must share
 455         # with Db.verify.
 456         DB_SA_SKIPFIRSTKEY              # UNDOC: I have no idea what this does.
 457         DB_SA_UNKNOWNKEY                # UNDOC: The salvage key is unknown
 458
 459 DbCursor.dup
 460         __MASK=0xff                     # Berkeley DB operation codes.
 461         DB_SHALLOW_DUP                  # UNDOC: Don't duplicate compression info
 462
 463 DbCursor.get
 464         __MASK=0xff                     # Berkeley DB operation codes.
 465         DB_IGNORE_LEASE                 # Ignore leases
 466         DB_MULTIPLE                     # Return multiple data values
 467         DB_MULTIPLE_KEY                 # Return multiple key/data pairs
 468         DB_READ_COMMITTED               # Degree 2 isolation
 469         DB_READ_UNCOMMITTED             # Degree 1 isolation
 470         DB_RMW                          # Acquire write lock immediately
 471
 472 DbCursor.put
 473         __MASK=0xff                     # Berkeley DB operation codes.