#include <db_cxx.h>

int
Dbc::put(Dbt *key, Dbt *data, u_int32_t flags);

Description: Dbc::put

The Dbc::put method stores key/data pairs into the database.

Unless otherwise specified, the Dbc::put method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

If Dbc::put fails for any reason, the state of the cursor will be unchanged. If Dbc::put succeeds and an item is inserted into the database, the cursor is always positioned to refer to the newly inserted item.

Parameters

data

The data Dbt operated on.

flags

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

DB_AFTER

In the case of the Btree and Hash access methods, insert the data element as a duplicate element of the key to which the cursor refers. The new element appears immediately after the current cursor position. It is an error to specify DB_AFTER if the underlying Btree or Hash database does not support duplicate data items. The key parameter is ignored.

In the case of the Recno access method, it is an error to specify DB_AFTER if the underlying Recno database was not created with the DB_RENUMBER flag. If the DB_RENUMBER flag was specified, a new key is created, all records after the inserted item are automatically renumbered, and the key of the new record is returned in the structure to which the key parameter refers. The initial value of the key parameter is ignored. See Db::open for more information.

The DB_AFTER flag may not be specified to the Queue access method.

The Dbc::put method will return DB_NOTFOUND if the current cursor record has already been deleted and the underlying access method is Hash.

DB_BEFORE

In the case of the Btree and Hash access methods, insert the data element as a duplicate element of the key to which the cursor refers. The new element appears immediately before the current cursor position. It is an error to specify DB_BEFORE if the underlying Btree or Hash database does not support duplicate data items. The key parameter is ignored.

In the case of the Recno access method, it is an error to specify DB_BEFORE if the underlying Recno database was not created with the DB_RENUMBER flag. If the DB_RENUMBER flag was specified, a new key is created, the current record and all records after it are automatically renumbered, and the key of the new record is returned in the structure to which the key parameter refers. The initial value of the key parameter is ignored. See Db::open for more information.

The DB_BEFORE flag may not be specified to the Queue access method.

The Dbc::put method will return DB_NOTFOUND if the current cursor record has already been deleted and the underlying access method is Hash.

DB_CURRENT

Overwrite the data of the key/data pair to which the cursor refers with the specified data item. The key parameter is ignored.

The Dbc::put method will return DB_NOTFOUND if the current cursor record has already been deleted.

DB_KEYFIRST

In the case of the Btree and Hash access methods, insert the specified key/data pair into the database.

If the underlying database supports duplicate data items, and if the key already exists in the database and a duplicate sort function has been specified, the inserted data item is added in its sorted location. If the key already exists in the database and no duplicate sort function has been specified, the inserted data item is added as the first of the data items for that key.

The DB_KEYFIRST flag may not be specified to the Queue or Recno access methods.

DB_KEYLAST

In the case of the Btree and Hash access methods, insert the specified key/data pair into the database.

If the underlying database supports duplicate data items, and if the key already exists in the database and a duplicate sort function has been specified, the inserted data item is added in its sorted location. If the key already exists in the database, and no duplicate sort function has been specified, the inserted data item is added as the last of the data items for that key.

The DB_KEYLAST flag may not be specified to the Queue or Recno access methods.

DB_NODUPDATA

In the case of the Btree and Hash access methods, insert the specified key/data pair into the database, unless a key/data pair comparing equally to it already exists in the database. If a matching key/data pair already exists in the database, DB_KEYEXIST is returned. The DB_NODUPDATA flag may only be specified if the underlying database has been configured to support sorted duplicate data items.

The DB_NODUPDATA flag may not be specified to the Queue or Recno access methods.

key

The key Dbt operated on.

Errors

The Dbc::put method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EACCES

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

DB_REP_HANDLE_DEAD

The database handle has been invalidated because a replication election unrolled a committed transaction.

EINVAL

If the DB_AFTER, DB_BEFORE or DB_CURRENT flags were specified and the cursor has not been initialized; the DB_AFTER or DB_BEFORE flags were specified and a duplicate sort function has been specified; the DB_CURRENT flag was specified, a duplicate sort function has been specified, and the data item of the referenced key/data pair does not compare equally to the data parameter; the DB_AFTER or DB_BEFORE flags were specified, and the underlying access method is Queue; an attempt was made to add a record to a fixed-length database that was too large to fit; an attempt was made to add a record to a secondary index; or if an invalid flag value or parameter was specified.

EPERM

Write attempted on read-only cursor when the DB_INIT_CDB flag was specified to DbEnv::open.

If a transactional database environment operation was selected to resolve a deadlock, the Dbc::put method will fail and either return DB_LOCK_DEADLOCK or throw a DbDeadlockException exception.

If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time, the Dbc::put method will fail and either return DB_LOCK_NOTGRANTED or throw a DbLockNotGrantedException exception.

Class

See Also