Berkeley DB: Db.put
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# Db.put |

`

###

    import com.sleepycat.db.*;

    public int put(DbTxn txnid, Dbt key, Dbt data, int flags)
    	throws DbException;

# Description

The Db.put method stores key/data pairs in the database.

If the database supports duplicates, the Db.put method adds the new data value at the end of the duplicate set. If the database supports sorted duplicates, the new data value is inserted at the correct sorted location.

If the file is being accessed under transaction protection, the txnid parameter is a transaction ID returned from DbEnv.txn_begin, otherwise, NULL.

The flags parameter must be set to 0 or one of the following values:

Db.DB_APPEND
  Append the key/data pair to the end of the database. For the Db.DB_APPEND flag to be specified, the underlying database must be a Queue or Recno database. The record number allocated to the record is returned in the specified key.

  There is a minor behavioral difference between the Recno and Queue access methods for the Db.DB_APPEND flag. If a transaction enclosing a Db.put operation with the Db.DB_APPEND flag aborts, the record number may be decremented (and later re-allocated by a subsequent Db.DB_APPEND operation) by the Recno access method, but will not be decremented or re-allocated by the Queue access method.

Db.DB_NOOVERWRITE
  Enter the new key/data pair only if the key does not already appear in the database.

The default behavior of the Db.put function is to enter the new key/data pair, replacing any previously existing key if duplicates are disallowed, or to add a duplicate entry if duplicates are allowed. Even if the designated database allows duplicates, a call to Db.put with the DB_NOOVERWRITE flag set will fail if the key already exists in the database.

The Db.put method throws an exception that encapsulates a non-zero error value on failure,and returns Db.DB_KEYEXIST if the DB_NOOVERWRITE flag was set and the key already exists in the file.

# Errors

If a fatal error occurs in Berkeley DB, the Db.put method will fail and throw a DbRunRecoveryException, at which point all subsequent database calls will fail in the same way.

In addition, if the operation was selected to resolve a deadlock, the Db.put method will fail and throw a DbDeadlockException exception.

In addition, the Db.put method may fail and throw an exception encapsulating a non-zero error for the following conditions:

EACCES
  An attempt was made to modify a read-only database.

EINVAL
  An invalid flag value or parameter was specified.

  A record number of 0 was specified.

  An attempt was made to add a record to a fixed-length database that was too large to fit.

  An attempt was made to do a partial put.

  An attempt was made to store a data item identical to an already existing data item in a tree with sorted duplicates.

ENOSPC
  A btree exceeded the maximum btree depth (255).

In addition, the Db.put method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.

### Class

Db

# See Also

Db.close, Db.cursor, Db.del, Db.fd, Db.get, Db.get_byteswapped, Db.get_type, Db.join, Db.open, Db.put, Db.remove, Db.set_bt_minkey, Db.set_cachesize, Db.set_errcall, Db.set_errpfx, Db.set_flags, Db.set_h_ffactor, Db.set_h_nelem, Db.set_lorder, Db.set_pagesize, Db.set_re_delim, Db.set_re_len, Db.set_re_pad, Db.set_re_source, Db.stat, Db.sync and Db.upgrade.`

Copyright Sleepycat Software