hamsterdb Embedded Database  2.1.7
Public Member Functions | Private Attributes
hamsterdb::env Class Reference

#include <hamsterdb.hpp>

Public Member Functions

 env ()
 
 ~env ()
 
void create (const char *filename, ham_u32_t flags=0, ham_u32_t mode=0644, const ham_parameter_t *param=0)
 
void open (const char *filename, ham_u32_t flags=0, const ham_parameter_t *param=0)
 
void flush (ham_u32_t flags=0)
 
db create_db (ham_u16_t name, ham_u32_t flags=0, const ham_parameter_t *param=0)
 
db open_db (ham_u16_t name, ham_u32_t flags=0, const ham_parameter_t *param=0)
 
void rename_db (ham_u16_t oldname, ham_u16_t newname, ham_u32_t flags=0)
 
void erase_db (ham_u16_t name, ham_u32_t flags=0)
 
txn begin (const char *name=0)
 
void close (ham_u32_t flags=0)
 
void get_parameters (ham_parameter_t *param)
 
std::vector< ham_u16_tget_database_names ()
 

Private Attributes

ham_env_tm_env
 

Detailed Description

An Environment class.

This class wraps the ham_env_t structure.

Definition at line 583 of file hamsterdb.hpp.

Constructor & Destructor Documentation

hamsterdb::env::env ( )
inline

Constructor

Definition at line 586 of file hamsterdb.hpp.

hamsterdb::env::~env ( )
inline

Destructor - automatically closes the Cursor, if necessary.

Definition at line 591 of file hamsterdb.hpp.

References close().

Member Function Documentation

txn hamsterdb::env::begin ( const char *  name = 0)
inline

Begin a new Transaction

Definition at line 657 of file hamsterdb.hpp.

References error(), ham_txn_begin(), and m_env.

void hamsterdb::env::close ( ham_u32_t  flags = 0)
inline

Closes the Environment.

Definition at line 667 of file hamsterdb.hpp.

References error(), HAM_AUTO_CLEANUP, ham_env_close(), and m_env.

Referenced by run_demo(), and ~env().

void hamsterdb::env::create ( const char *  filename,
ham_u32_t  flags = 0,
ham_u32_t  mode = 0644,
const ham_parameter_t param = 0 
)
inline

Creates a new Environment.

Definition at line 596 of file hamsterdb.hpp.

References error(), ham_env_create(), and m_env.

Referenced by run_demo().

db hamsterdb::env::create_db ( ham_u16_t  name,
ham_u32_t  flags = 0,
const ham_parameter_t param = 0 
)
inline

Creates a new Database in the Environment.

Definition at line 619 of file hamsterdb.hpp.

References error(), ham_env_create_db(), and m_env.

Referenced by run_demo().

void hamsterdb::env::erase_db ( ham_u16_t  name,
ham_u32_t  flags = 0 
)
inline

Deletes a Database from the Environment.

Definition at line 650 of file hamsterdb.hpp.

References error(), ham_env_erase_db(), and m_env.

void hamsterdb::env::flush ( ham_u32_t  flags = 0)
inline

Flushes the Environment to disk.

Definition at line 612 of file hamsterdb.hpp.

References error(), ham_env_flush(), and m_env.

std::vector<ham_u16_t> hamsterdb::env::get_database_names ( )
inline

Get all Database names.

Definition at line 687 of file hamsterdb.hpp.

References error(), ham_env_get_database_names(), HAM_LIMITS_REACHED, and m_env.

void hamsterdb::env::get_parameters ( ham_parameter_t param)
inline

Retrieves Environment parameters.

Definition at line 680 of file hamsterdb.hpp.

References error(), ham_env_get_parameters(), and m_env.

void hamsterdb::env::open ( const char *  filename,
ham_u32_t  flags = 0,
const ham_parameter_t param = 0 
)
inline

Opens an existing Environment.

Definition at line 604 of file hamsterdb.hpp.

References error(), ham_env_open(), and m_env.

Referenced by run_demo().

db hamsterdb::env::open_db ( ham_u16_t  name,
ham_u32_t  flags = 0,
const ham_parameter_t param = 0 
)
inline

Opens an existing Database in the Environment.

Definition at line 631 of file hamsterdb.hpp.

References error(), ham_env_open_db(), and m_env.

Referenced by run_demo().

void hamsterdb::env::rename_db ( ham_u16_t  oldname,
ham_u16_t  newname,
ham_u32_t  flags = 0 
)
inline

Renames an existing Database in the Environment.

Definition at line 643 of file hamsterdb.hpp.

References error(), ham_env_rename_db(), and m_env.

Field Documentation

ham_env_t* hamsterdb::env::m_env
private

The documentation for this class was generated from the following file: