Collapse All Expand All Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++

C#
Visual Basic
Visual C++

Berkeley DB .NET API Documentation
RecnoDatabaseConfig..::.BackingFile Field
RecnoDatabaseConfig Class See Also Send Feedback

The underlying source file for the Recno access method.

Namespace: BerkeleyDB
Assembly: libdb_dotnet53 (in libdb_dotnet53.dll) Version: 5.3.28.0

# Syntax

C#
    public string BackingFile

Visual Basic (Declaration)
    Public BackingFile As String

Visual C++
    public:
    String^ BackingFile

# Remarks

The purpose of the source file is to provide fast access and modification to databases that are normally stored as flat text files.

The source parameter specifies an underlying flat text database file that is read to initialize a transient record number index. In the case of variable length records, the records are separated, as specified by Delimiter. For example, standard UNIX byte stream files can be interpreted as a sequence of variable length records separated by newline characters.

In addition, when cached data would normally be written back to the underlying database file (for example, Close()()() or Sync()()()), the in-memory copy of the database will be written back to the source file.

By default, the backing source file is read lazily; that is, records are not read from the file until they are requested by the application. If multiple processes (not threads) are accessing a Recno database concurrently, and are either inserting or deleting records, the backing source file must be read in its entirety before more than a single process accesses the database, and only that process should specify the backing source file as part of the Open(String, RecnoDatabaseConfig) call. See Snapshot for more information.

Reading and writing the backing source file specified by source cannot be transaction-protected because it involves filesystem operations that are not part of the Db transaction methodology. For this reason, if a temporary database is used to hold the records, it is possible to lose the contents of the source file, for example, if the system crashes at the right instant. If a file is used to hold the database, normal database recovery on that file can be used to prevent information loss, although it is still possible that the contents of source will be lost if the system crashes.

The source file must already exist (but may be zero-length) when Open(String, RecnoDatabaseConfig) is called.

It is not an error to specify a read-only source file when creating a database, nor is it an error to modify the resulting database. However, any attempt to write the changes to the backing source file using either the Sync()()() or Close()()() methods will fail, of course. Use Close(Boolean) to stop it from attempting to write the changes to the backing file; instead, they will be silently discarded.

For all of the previous reasons, the source file is generally used to specify databases that are read-only for Berkeley DB applications; and that are either generated on the fly by software tools or modified using a different mechanism — for example, a text editor.

If the database already exists, BackingFile must be the same as that historically used to create the database or corruption can occur.

# See Also

RecnoDatabaseConfig Class
BerkeleyDB Namespace