hamsterdb Database Information Request Parameters
[hamsterdb Database Configuration]

Defines

#define HAM_PARAM_GET_FLAGS   0x00000200
#define HAM_PARAM_GET_FILEMODE   0x00000201
#define HAM_PARAM_GET_FILENAME   0x00000202
#define HAM_PARAM_DBNAME   0x00000203
#define HAM_PARAM_GET_KEYS_PER_PAGE   0x00000204
#define HAM_PARAM_GET_DAM   0x00000205
#define HAM_PARAM_GET_STATISTICS   0x00000206

Detailed Description

Parameter names to query information from the Database through calls to ham_env_get_parameters and ham_get_parameters.

See also:
ham_parameter_t

Define Documentation

#define HAM_PARAM_DBNAME   0x00000203

Retrieve the 'dbname' number of this ham_db_t Database within the current ham_env_t Environment.

When the Database is not related to an Environment, the 'dbname' i HAM_FIRST_DATABASE_NAME is used for the Database.

Definition at line 1517 of file hamsterdb.h.

#define HAM_PARAM_GET_DAM   0x00000205

Retrieve the Data Access mode for the Database

Definition at line 1532 of file hamsterdb.h.

#define HAM_PARAM_GET_FILEMODE   0x00000201

Retrieve the filesystem file access mode as was specified at the time of ham_create/ham_env_create/ham_open/ham_env_open invocation.

Definition at line 1499 of file hamsterdb.h.

#define HAM_PARAM_GET_FILENAME   0x00000202

Return a const char * pointer to the current Environment/Database file name in the ham_offset_t value member, when the Database is actually stored on disc.

In-memory Databases will return a NULL (0) pointer instead.

Definition at line 1508 of file hamsterdb.h.

#define HAM_PARAM_GET_FLAGS   0x00000200

Retrieve the Database/Environment flags as were specified at the time of ham_create/ham_env_create/ham_open/ham_env_open invocation.

Definition at line 1492 of file hamsterdb.h.

#define HAM_PARAM_GET_KEYS_PER_PAGE   0x00000204

Retrieve the actual number of keys per page; this number depends on the currently active page and key sizes.

When no Database or Environment is specified with the request, the default settings for all of these will be assumed in order to produce a viable ball park value for this one.

Definition at line 1527 of file hamsterdb.h.

#define HAM_PARAM_GET_STATISTICS   0x00000206

Retrieve a ham_statistics_t structure with the current statistics.

Warning:
Please, heed the warnings and notes listed in the ham_statistics_t documentation section and follow the advice given there to the letter. Not adhering to these adminishions introduces the risk of hamsterdb becoming unstable and exhibiting unreliable and downright faulty behaviour over time. This includes, but is not limited to, core dumps or comparable system crashes.

If you do not feel entirely qualified to use this particular section of the hamsterdb API, refrain from using HAM_PARAM_GET_STATISTICS and ham_statistics_t and consult a professional for assitance if your application needs access to this kind of 'core data'.

hamsterdb is, to the best of my knowledge, the only Database engine which makes this degree of power available to the user. With using that power comes a responsibility. Cave canem.

See also:
ham_statistics_t
ham_get_parameters
ham_env_get_parameters

Definition at line 1558 of file hamsterdb.h.


Generated on Thu Feb 11 22:04:58 2010 for hamsterdb Embedded Database by  doxygen 1.6.1