C# Class BerkeleyDB.SecondaryBTreeDatabase

A class representing a SecondaryBTreeDatabase. The Btree format is a representation of a sorted, balanced tree structure.
Inheritance: BerkeleyDB.SecondaryDatabase
Show file Open project: coapp-packages/berkeleydb Class Usage Examples

Public Methods

Method Description
Open ( string Filename, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg ) : SecondaryBTreeDatabase

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If Filename is null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe.

If DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open.

Open ( string Filename, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg, BerkeleyDB.Transaction txn ) : SecondaryBTreeDatabase

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If Filename is null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe.

If txn is null, but DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open. Also note that the transaction must be committed before the object is closed.

Open ( string Filename, string DatabaseName, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg ) : SecondaryBTreeDatabase

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If both Filename and DatabaseName are null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe. If Filename is null and DatabaseName is non-null, the database can be opened by other threads of control and will be replicated to client sites in any replication group.

If DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open.

Open ( string Filename, string DatabaseName, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg, BerkeleyDB.Transaction txn ) : SecondaryBTreeDatabase

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If both Filename and DatabaseName are null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe. If Filename is null and DatabaseName is non-null, the database can be opened by other threads of control and will be replicated to client sites in any replication group.

If txn is null, but DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open. Also note that the transaction must be committed before the object is closed.

Private Methods

Method Description
Config ( BerkeleyDB.SecondaryBTreeDatabaseConfig cfg ) : void
SecondaryBTreeDatabase ( BerkeleyDB.DatabaseEnvironment env, uint flags ) : System
doCompare ( IntPtr dbp, IntPtr dbtp1, IntPtr dbtp2 ) : int
doDupCompare ( IntPtr dbp, IntPtr dbt1p, IntPtr dbt2p ) : int
doPrefixCompare ( IntPtr dbp, IntPtr dbtp1, IntPtr dbtp2 ) : uint

Method Details

Open() public static method

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If Filename is null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe.

If DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open.

public static Open ( string Filename, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg ) : SecondaryBTreeDatabase
Filename string /// The name of an underlying file that will be used to back the /// database. In-memory databases never intended to be preserved on disk /// may be created by setting this parameter to null. ///
cfg BerkeleyDB.SecondaryBTreeDatabaseConfig The database's configuration
return SecondaryBTreeDatabase

Open() public static method

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If Filename is null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe.

If txn is null, but DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open. Also note that the transaction must be committed before the object is closed.

public static Open ( string Filename, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg, BerkeleyDB.Transaction txn ) : SecondaryBTreeDatabase
Filename string /// The name of an underlying file that will be used to back the /// database. In-memory databases never intended to be preserved on disk /// may be created by setting this parameter to null. ///
cfg BerkeleyDB.SecondaryBTreeDatabaseConfig The database's configuration
txn BerkeleyDB.Transaction /// If the operation is part of an application-specified transaction, /// is a Transaction object returned from /// ; if /// the operation is part of a Berkeley DB Concurrent Data Store group, /// is a handle returned from /// ; otherwise null. ///
return SecondaryBTreeDatabase

Open() public static method

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If both Filename and DatabaseName are null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe. If Filename is null and DatabaseName is non-null, the database can be opened by other threads of control and will be replicated to client sites in any replication group.

If DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open.

public static Open ( string Filename, string DatabaseName, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg ) : SecondaryBTreeDatabase
Filename string /// The name of an underlying file that will be used to back the /// database. In-memory databases never intended to be preserved on disk /// may be created by setting this parameter to null. ///
DatabaseName string /// This parameter allows applications to have multiple databases in a /// single file. Although no DatabaseName needs to be specified, it is /// an error to attempt to open a second database in a file that was not /// initially created using a database name. ///
cfg BerkeleyDB.SecondaryBTreeDatabaseConfig The database's configuration
return SecondaryBTreeDatabase

Open() public static method

Instantiate a new SecondaryBTreeDatabase object, open the database represented by Filename and associate the database with the primary index.

If both Filename and DatabaseName are null, the database is strictly temporary and cannot be opened by any other thread of control, thus the database can only be accessed by sharing the single database object that created it, in circumstances where doing so is safe. If Filename is null and DatabaseName is non-null, the database can be opened by other threads of control and will be replicated to client sites in any replication group.

If txn is null, but DatabaseConfig.AutoCommit is set, the operation will be implicitly transaction protected. Note that transactionally protected operations on a datbase object requires the object itself be transactionally protected during its open. Also note that the transaction must be committed before the object is closed.

public static Open ( string Filename, string DatabaseName, BerkeleyDB.SecondaryBTreeDatabaseConfig cfg, BerkeleyDB.Transaction txn ) : SecondaryBTreeDatabase
Filename string /// The name of an underlying file that will be used to back the /// database. In-memory databases never intended to be preserved on disk /// may be created by setting this parameter to null. ///
DatabaseName string /// This parameter allows applications to have multiple databases in a /// single file. Although no DatabaseName needs to be specified, it is /// an error to attempt to open a second database in a file that was not /// initially created using a database name. ///
cfg BerkeleyDB.SecondaryBTreeDatabaseConfig The database's configuration
txn BerkeleyDB.Transaction /// If the operation is part of an application-specified transaction, /// is a Transaction object returned from /// ; if /// the operation is part of a Berkeley DB Concurrent Data Store group, /// is a handle returned from /// ; otherwise null. ///
return SecondaryBTreeDatabase