head 1.2; access; symbols RPM_4_2_1:1.1.1.5 RPM_4_2:1.1.1.5 RPM_4_1_1:1.1.1.5 RPM_4_1:1.1.1.4 RPM_4_0_5:1.1.1.3 RPM_4_0_4:1.1.1.2 RPM_4_0_3:1.1.1.1 RPM:1.1.1; locks; strict; comment @# @; 1.2 date 2008.01.02.09.53.54; author rse; state dead; branches; next 1.1; commitid z4cpSiAhOCXk5PLs; 1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches; next 1.1.1.2; 1.1.1.2 date 2002.01.08.00.30.10; author rse; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2003.01.18.13.48.59; author rse; state Exp; branches; next 1.1.1.4; 1.1.1.4 date 2001.12.06.00.08.08; author rse; state Exp; branches; next 1.1.1.5; 1.1.1.5 date 2003.01.18.14.04.58; author rse; state Exp; branches; next ; desc @@ 1.2 log @remove the ancient RPM 4.2.1 source tree copy @ text @ Berkeley DB: Db.close

Db.close

APIRef

import com.sleepycat.db.*;

public int close(int flags) throws DbException;

Description

The Db.close method flushes any cached database information to disk, closes any open cursors, frees any allocated resources, and closes any underlying files. Because key/data pairs are cached in memory, failing to sync the file with the Db.close or Db.sync method may result in inconsistent or lost information.

The flags value must be set to 0 or the following value:

Db.DB_NOSYNC
Do not flush cached information to disk. The Db.DB_NOSYNC flag is a dangerous option. It should be set only if the application is doing logging (with transactions) so that the database is recoverable after a system or application crash, or if the database is always generated from scratch after any system or application crash.

It is important to understand that flushing cached information to disk only minimizes the window of opportunity for corrupted data. Although unlikely, it is possible for database corruption to happen if a system or application crash occurs while writing data to the database. To ensure that database corruption never occurs, applications must either: use transactions and logging with automatic recovery; use logging and application-specific recovery; or edit a copy of the database, and once all applications using the database have successfully called Db.close, atomically replace the original database with the updated copy.

When multiple threads are using the Berkeley DB handle concurrently, only a single thread may call the Db.close method.

After Db.close has been called, regardless of its return, the Db handle may not be accessed again.

The Db.close method throws an exception that encapsulates a non-zero error value on failure, and returns Db.DB_INCOMPLETE if the underlying database still has dirty pages in the cache. (The only reason to return Db.DB_INCOMPLETE is if another thread of control were writing pages in the underlying database file at the same time as the Db.close method was called. For this reason, a return of Db.DB_INCOMPLETE can normally be ignored; or, in cases where it is a possible return value, the Db.DB_NOSYNC option should probably have been specified.)

Errors

The Db.close method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Db.close method may fail and throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

Db

See Also

Db.associate, Db.close, Db.cursor, Db.del, Db.fd, Db.get, Db.pget, Db.get_byteswapped, Db.get_type, Db.join, Db.key_range, Db.open, Db.put, Db.remove, Db.rename, Db.set_append_recno, Db.set_bt_minkey, Db.set_cachesize, Db.set_errcall, Db.set_errpfx, Db.set_feedback, Db.set_flags, Db.set_h_ffactor, Db.set_h_nelem, Db.set_lorder, Db.set_pagesize, Db.set_q_extentsize, Db.set_re_delim, Db.set_re_len, Db.set_re_pad, Db.set_re_source, Db.stat, Db.sync, Db.truncate, Db.upgrade, and Db.verify.

APIRef

Copyright Sleepycat Software @ 1.1 log @Initial revision @ text @d1 1 a1 1 @ 1.1.1.1 log @Import: RPM 4.0.3 @ text @@ 1.1.1.2 log @Import: RPM 4.0.4 @ text @d1 1 a1 1 d17 1 a17 1 APIRef d25 1 a25 1 throws DbException; d113 1 a113 1 APIRef @ 1.1.1.3 log @Import: RPM 4.0.5 @ text @d1 2 a2 3 a3 1 d33 2 a34 2

The flags value must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values: d52 1 a52 1

When multiple threads are using the Db concurrently, only a single d54 3 a56 2

The Db handle may not be accessed again after Db.close is called, regardless of its return. d58 8 a65 1 failure. a66 4

The Db.close method may fail and throw an exception encapsulating a non-zero error for the following conditions:

EINVAL
An invalid flag value or parameter was specified.
d68 3 a70 3 If a catastrophic error has occurred, the Db.close method may fail and throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way. d74 37 a110 1 Databases and Related Methods @ 1.1.1.4 log @Import: RPM 4.1 @ text @d1 3 a3 2 d5 1 d35 2 a36 2

The flags value must be set to 0 or the following value: d54 1 a54 1

When multiple threads are using the Berkeley DB handle concurrently, only a single d56 2 a57 3

After Db.close has been called, regardless of its return, the Db handle may not be accessed again. d59 1 a59 8 failure, and returns Db.DB_INCOMPLETE if the underlying database still has dirty pages in the cache. (The only reason to return Db.DB_INCOMPLETE is if another thread of control were writing pages in the underlying database file at the same time as the Db.close method was called. For this reason, a return of Db.DB_INCOMPLETE can normally be ignored; or, in cases where it is a possible return value, the Db.DB_NOSYNC option should probably have been specified.) d61 4 d66 3 a68 3 If a catastrophic error has occurred, the Db.close method may fail and throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way. d72 1 a72 37 Db.associate, Db.close, Db.cursor, Db.del, Db.fd, Db.get, Db.pget, Db.get_byteswapped, Db.get_type, Db.join, Db.key_range, Db.open, Db.put, Db.remove, Db.rename, Db.set_append_recno, Db.set_bt_minkey, Db.set_cachesize, Db.set_errcall, Db.set_errpfx, Db.set_feedback, Db.set_flags, Db.set_h_ffactor, Db.set_h_nelem, Db.set_lorder, Db.set_pagesize, Db.set_q_extentsize, Db.set_re_delim, Db.set_re_len, Db.set_re_pad, Db.set_re_source, Db.stat, Db.sync, Db.truncate, Db.upgrade, and Db.verify. @ 1.1.1.5 log @Import: RPM 4.1.1 @ text @d1 2 a2 3 a3 1 d33 2 a34 2

The flags value must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values: d52 1 a52 1

When multiple threads are using the Db concurrently, only a single d54 3 a56 2

The Db handle may not be accessed again after Db.close is called, regardless of its return. d58 8 a65 1 failure. a66 4

The Db.close method may fail and throw an exception encapsulating a non-zero error for the following conditions:

EINVAL
An invalid flag value or parameter was specified.
d68 3 a70 3 If a catastrophic error has occurred, the Db.close method may fail and throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way. d74 37 a110 1 Databases and Related Methods @