#include <hamsterdb.h>

Data Fields
ham_u32_t	size
void *	data
ham_u32_t	flags
ham_u32_t	partial_offset
ham_u32_t	partial_size
ham_u32_t	_intflags
ham_u64_t	_rid

Detailed Description

A generic record.

A record represents data items in hamsterdb. Before using a record, it is important to initialize all record fields with zeroes, i.e. with the C library routines memset(3) or bzero(2).

When hamsterdb returns a record structure, the pointer to the record data is provided in data. This pointer is only temporary and will be overwritten by subsequent hamsterdb API calls using the same Transaction (or, if Transactions are disabled, using the same Database). The pointer will also be invalidated after the Transaction is aborted or committed.

To avoid this, the calling application can allocate the data pointer. In this case, you have to set the flag HAM_RECORD_USER_ALLOC. The size parameter will then return the size of the record. It's the responsibility of the caller to make sure that the data parameter is large enough for the record.

The record->data pointer is not threadsafe. For threadsafe access it is recommended to use HAM_RECORD_USER_ALLOC or have each thread manage its own Transaction.

Definition at line 172 of file hamsterdb.h.