DBcursor->c_put

API Ref

#include <db.h>

int DBcursor->c_put(DBC *DBcursor, DBT *key, DBT *data, u_int32_t flags);


Description: DBcursor->c_put

The DBcursor->c_put method stores key/data pairs into the database.

Unless otherwise specified, the DBcursor->c_put method returns a non-zero error value on failure and 0 on success.

If DBcursor->c_put fails for any reason, the state of the cursor will be unchanged. If DBcursor->c_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.

(Btree and Hash의 경우,커서가 참조하고 있는 키의 duplicate 요소로서 데이타아이템을 삽입한다.새로운 요소는 현재 커서포지션 바로 직후에 나타난다.데이타아이템의 duplicate를 지원하지 않게 설정된 Btree 또는 Hash에서 DB_AFTER 를 사용하는 것은 에러다. 키인자는 무시된다.)

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.

(Recno에서,DB_RENUMBER플래그로 설정되지 않고 DB_AFTER 를 사용하는 것은 에러다.만약 DB_RENUMBER가 설정되었다면 새로운 키는 생성되고 삽입된 레코드 후의 모든 레코드는 자동으로 재넘버링된다.그리고 새로운 레코드의 키는 key 파라미터가 참조하고 있는 구조체에 리턴된다.초기 key파라미터는 무시된다.)

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

(DB_AFTER 는 큐에 설정되지 않아야 한다.)

The DBcursor->c_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 DBcursor->c_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.

지정된 data아이템을 가르키는 커서위치에 key/data pair의 data로 덥어쓰여진다.

The DBcursor->c_put method will return DB_NOTFOUND if the current cursor record has already been deleted and the underlying access method is Hash.

만약에 현재 커서 레코드가 이미 지워졌거나 Hash access method일 경우 DBcursor-c_put메소드는 DB_NOTFOUND를 리턴할 것이다.

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.

만약 database가 duplicate data를 지원하고 key가 이미 database에 존재하고 duplicate sort 함수가 지정되었다면 삽입된 data 아이템은 그것의 정렬된 위치에 추가된다. 만약 key가 이미 database에 존재하고 duplicate sort 함수가 지정되지 않았다면 삽입된 data 아이템은 그 키를 위한 첫번째 data아이템으로서 추가된다.

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.

Btree와 Hash access method의 경우, 만약 key/data쌍이 이미 database상에 존재하는 것과 같지 않다면 지정된 key/data쌍은 database에 삽입된다. 만약 key와 data싸이 database상에 존재한다면 DB_KEYEXIST가 리턴된다. DB_NODUPDATA플래그는 오직 정렬된 duplicate data items이 지원되는 환경을 갖는 database에만 허락된다.

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

key
The key DBT operated on.

Errors

The DBcursor->c_put method may fail and return one of the following non-zero errors:

DB_LOCK_DEADLOCK
A transactional database environment operation was selected to resolve a deadlock.

DB_LOCK_NOTGRANTED
A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time.

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 DB_ENV->open.

Class

DBC

See Also

Database Cursors and Related Methods

APIRef

Copyright (c) 1996-2003 Sleepycat Software, Inc. - All rights reserved.