# Db.sync

`

###

    import com.sleepycat.db.*;

    public int sync(int flags)
        throws DbException;

# Description

The Db.sync method flushes any cached information to disk.

If the database is in memory only, the Db.sync method has no effect and will always succeed.

The flags parameter is currently unused, and must be set to 0.

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.

The Db.sync 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 was writing pages in the underlying database file at the same time as the Db.sync method was being called. For this reason, a return of Db.DB_INCOMPLETE can normally be ignored; or, in cases where it is a possible return value, there may be no reason to call Db.sync.)

# Errors

The Db.sync 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.

The Db.sync 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.sync 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.`

Copyright Sleepycat Software