Loading...
Searching...
No Matches
Data Fields | Related Symbols
as_rec Struct Reference

Detailed Description

as_rec is an interface for record types. A record is how data in Aerospike is represented, and is composed of bins and metadata.

Implementations:

Definition at line 74 of file as_rec.h.

#include "as_rec.h"

+ Inheritance diagram for as_rec:
+ Collaboration diagram for as_rec:

Data Fields

void * data
 
const struct as_rec_hooks_s * hooks
 
- Data Fields inherited from as_val
uint32_t count
 
bool free
 
as_val_t type
 

Related Symbols

(Note that these are not member symbols.)

static int as_rec_bin_names (const as_rec *rec, as_rec_bin_names_callback callback, void *udata)
 
AS_EXTERN as_recas_rec_cons (as_rec *rec, bool free, void *data, const as_rec_hooks *hooks)
 
static void as_rec_destroy (as_rec *rec)
 
static uint32_t as_rec_device_size (const as_rec *rec)
 
static as_bytesas_rec_digest (const as_rec *rec)
 
static int as_rec_drop_key (const as_rec *rec)
 
static bool as_rec_foreach (const as_rec *rec, as_rec_foreach_callback callback, void *udata)
 
static as_recas_rec_fromval (const as_val *v)
 
static uint16_t as_rec_gen (const as_rec *rec)
 
static as_valas_rec_get (const as_rec *rec, const char *name)
 
static as_doubleas_rec_get_as_double (const as_rec *rec, const char *name)
 
static as_bytesas_rec_get_bytes (const as_rec *rec, const char *name)
 
static double as_rec_get_double (const as_rec *rec, const char *name)
 
static as_geojsonas_rec_get_geojson (const as_rec *rec, const char *name)
 
static char * as_rec_get_geojson_str (const as_rec *rec, const char *name)
 
static int64_t as_rec_get_int64 (const as_rec *rec, const char *name)
 
static as_integeras_rec_get_integer (const as_rec *rec, const char *name)
 
static as_listas_rec_get_list (const as_rec *rec, const char *name)
 
static as_mapas_rec_get_map (const as_rec *rec, const char *name)
 
static char * as_rec_get_str (const as_rec *rec, const char *name)
 
static as_stringas_rec_get_string (const as_rec *rec, const char *name)
 
AS_EXTERN as_recas_rec_init (as_rec *rec, void *data, const as_rec_hooks *hooks)
 
static as_valas_rec_key (const as_rec *rec)
 
static uint64_t as_rec_last_update_time (const as_rec *rec)
 
static uint32_t as_rec_memory_size (const as_rec *rec)
 
AS_EXTERN as_recas_rec_new (void *data, const as_rec_hooks *hooks)
 
static uint16_t as_rec_numbins (const as_rec *rec)
 
static int as_rec_remove (const as_rec *rec, const char *name)
 
static int as_rec_set (const as_rec *rec, const char *name, const as_val *value)
 
static int as_rec_set_as_double (const as_rec *rec, const char *name, const as_double *value)
 
static int as_rec_set_bytes (const as_rec *rec, const char *name, const as_bytes *value)
 
static int as_rec_set_double (const as_rec *rec, const char *name, double value)
 
static int as_rec_set_geojson (const as_rec *rec, const char *name, const as_geojson *value)
 
static int as_rec_set_int64 (const as_rec *rec, const char *name, int64_t value)
 
static int as_rec_set_integer (const as_rec *rec, const char *name, const as_integer *value)
 
static int as_rec_set_list (const as_rec *rec, const char *name, const as_list *value)
 
static int as_rec_set_map (const as_rec *rec, const char *name, const as_map *value)
 
static int as_rec_set_str (const as_rec *rec, const char *name, const char *value)
 
static int as_rec_set_string (const as_rec *rec, const char *name, const as_string *value)
 
static int as_rec_set_ttl (const as_rec *rec, uint32_t ttl)
 
static const char * as_rec_setname (const as_rec *rec)
 
static uint32_t as_rec_size (const as_rec *rec)
 
static void * as_rec_source (const as_rec *rec)
 
static as_valas_rec_toval (const as_rec *rec)
 
static uint32_t as_rec_ttl (const as_rec *rec)
 

Friends And Related Symbol Documentation

◆ as_rec_bin_names()

static int as_rec_bin_names ( const as_rec * rec,
as_rec_bin_names_callback callback,
void * udata )
related

Get a list of the bin names in the record.

Definition at line 379 of file as_rec.h.

References as_util_hook.

◆ as_rec_cons()

AS_EXTERN as_rec * as_rec_cons ( as_rec * rec,
bool free,
void * data,
const as_rec_hooks * hooks )
related

Utilized by subtypes of as_rec to initialize the parent.

Parameters
recThe record to initialize
freeIf TRUE, then as_rec_destory() will free the record.
dataData for the map.
hooksImplementation for the map interface.
Returns
The initialized as_map on success. Otherwise NULL.

◆ as_rec_destroy()

static void as_rec_destroy ( as_rec * rec)
related

Destroy the record.

Definition at line 249 of file as_rec.h.

References as_val_destroy.

◆ as_rec_device_size()

static uint32_t as_rec_device_size ( const as_rec * rec)
related

Get the device storage size of the record - deprecated!

Definition at line 339 of file as_rec.h.

References as_util_hook.

◆ as_rec_digest()

static as_bytes * as_rec_digest ( const as_rec * rec)
related

Get the digest of the record.

Definition at line 389 of file as_rec.h.

References as_util_hook.

◆ as_rec_drop_key()

static int as_rec_drop_key ( const as_rec * rec)
related

Drop the record's key.

Definition at line 409 of file as_rec.h.

References as_util_hook.

◆ as_rec_foreach()

static bool as_rec_foreach ( const as_rec * rec,
as_rec_foreach_callback callback,
void * udata )
related

Call the callback function for each bin in the record.

Parameters
recThe as_rec containing the bins to iterate over.
callbackThe function to call for each entry.
udataUser-data to be passed to the callback.
Returns
true if iteration completes fully. false if iteration was aborted.

Definition at line 808 of file as_rec.h.

References as_util_hook.

◆ as_rec_fromval()

static as_rec * as_rec_fromval ( const as_val * v)
related

Convert from an as_val.

Definition at line 832 of file as_rec.h.

References AS_REC, and as_util_fromval.

◆ as_rec_gen()

static uint16_t as_rec_gen ( const as_rec * rec)
related

Get the generation of the record

Definition at line 309 of file as_rec.h.

References as_util_hook.

◆ as_rec_get()

static as_val * as_rec_get ( const as_rec * rec,
const char * name )
related

Get a bin's value.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 428 of file as_rec.h.

References as_util_hook.

◆ as_rec_get_as_double()

static as_double * as_rec_get_as_double ( const as_rec * rec,
const char * name )
related

Get a bin's value as an as_double.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 527 of file as_rec.h.

References as_double_fromval(), and as_util_hook.

◆ as_rec_get_bytes()

static as_bytes * as_rec_get_bytes ( const as_rec * rec,
const char * name )
related

Get a bin's value as an as_bytes.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 575 of file as_rec.h.

References as_bytes_fromval(), and as_util_hook.

◆ as_rec_get_double()

static double as_rec_get_double ( const as_rec * rec,
const char * name )
related

Get a bin's value as a double.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise 0.

Definition at line 460 of file as_rec.h.

References as_double_fromval(), as_util_hook, and as_double::value.

◆ as_rec_get_geojson()

static as_geojson * as_rec_get_geojson ( const as_rec * rec,
const char * name )
related

Get a bin's value as an as_geojson.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 559 of file as_rec.h.

References as_geojson_fromval(), and as_util_hook.

◆ as_rec_get_geojson_str()

static char * as_rec_get_geojson_str ( const as_rec * rec,
const char * name )
related

Get a bin's value as a NULL terminated GeoJSON string.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 494 of file as_rec.h.

References as_geojson_fromval(), as_geojson_get(), and as_util_hook.

◆ as_rec_get_int64()

static int64_t as_rec_get_int64 ( const as_rec * rec,
const char * name )
related

Get a bin's value as an int64_t.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise 0.

Definition at line 443 of file as_rec.h.

References as_integer_fromval(), as_integer_toint(), and as_util_hook.

◆ as_rec_get_integer()

static as_integer * as_rec_get_integer ( const as_rec * rec,
const char * name )
related

Get a bin's value as an as_integer.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 511 of file as_rec.h.

References as_integer_fromval(), and as_util_hook.

◆ as_rec_get_list()

static as_list * as_rec_get_list ( const as_rec * rec,
const char * name )
related

Get a bin's value as an as_list.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 591 of file as_rec.h.

References as_list_fromval(), and as_util_hook.

◆ as_rec_get_map()

static as_map * as_rec_get_map ( const as_rec * rec,
const char * name )
related

Get a bin's value as an as_map.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 607 of file as_rec.h.

References as_map_fromval(), and as_util_hook.

◆ as_rec_get_str()

static char * as_rec_get_str ( const as_rec * rec,
const char * name )
related

Get a bin's value as a NULL terminated string.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 477 of file as_rec.h.

References as_string_fromval(), as_string_tostring(), and as_util_hook.

◆ as_rec_get_string()

static as_string * as_rec_get_string ( const as_rec * rec,
const char * name )
related

Get a bin's value as an as_string.

Parameters
recThe as_rec to read the bin value from.
nameThe name of the bin.
Returns
On success, the value of the bin. Otherwise NULL.

Definition at line 543 of file as_rec.h.

References as_string_fromval(), and as_util_hook.

◆ as_rec_init()

AS_EXTERN as_rec * as_rec_init ( as_rec * rec,
void * data,
const as_rec_hooks * hooks )
related

Initialize a stack allocated record.

Parameters
recStack allocated record to initialize.
dataData for the record.
hooksImplementation for the record interface.
Returns
On success, the initialized record. Otherwise NULL.

◆ as_rec_key()

static as_val * as_rec_key ( const as_rec * rec)
related

Get the record's key.

Definition at line 349 of file as_rec.h.

References as_util_hook.

◆ as_rec_last_update_time()

static uint64_t as_rec_last_update_time ( const as_rec * rec)
related

Get the last update time for the record.

Definition at line 299 of file as_rec.h.

References as_util_hook.

◆ as_rec_memory_size()

static uint32_t as_rec_memory_size ( const as_rec * rec)
related

Get the memory storage size of the record - deprecated!

Definition at line 329 of file as_rec.h.

References as_util_hook.

◆ as_rec_new()

AS_EXTERN as_rec * as_rec_new ( void * data,
const as_rec_hooks * hooks )
related

Create and initialize a new heap allocated record.

Parameters
dataData for the record.
hooksImplementation for the record interface.
Returns
On success, a new record. Otherwise NULL.

◆ as_rec_numbins()

static uint16_t as_rec_numbins ( const as_rec * rec)
related

Get the number of bins in the record.

Definition at line 369 of file as_rec.h.

References as_util_hook.

◆ as_rec_remove()

static int as_rec_remove ( const as_rec * rec,
const char * name )
related

Set bin value to nil. This will instruct the server to remove the bin when the record is written using aerospike_key_put().

Parameters
recThe record to remove the bin from.
nameThe name of the bin to remove.
Returns
0 on success, otherwise an error occurred.

Definition at line 279 of file as_rec.h.

References as_util_hook.

◆ as_rec_set()

static int as_rec_set ( const as_rec * rec,
const char * name,
const as_val * value )
related

Set the bin's value to an as_val.

Parameters
recThe as_rec to write the bin value to - CONSUMES REFERENCE
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 628 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_as_double()

static int as_rec_set_as_double ( const as_rec * rec,
const char * name,
const as_double * value )
related

Set the bin's value to an as_double.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 708 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_bytes()

static int as_rec_set_bytes ( const as_rec * rec,
const char * name,
const as_bytes * value )
related

Set the bin's value to an as_bytes.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 756 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_double()

static int as_rec_set_double ( const as_rec * rec,
const char * name,
double value )
related

Set the bin's value to a double.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 660 of file as_rec.h.

References as_double_new(), and as_util_hook.

◆ as_rec_set_geojson()

static int as_rec_set_geojson ( const as_rec * rec,
const char * name,
const as_geojson * value )
related

Set the bin's value to an as_geojson.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 740 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_int64()

static int as_rec_set_int64 ( const as_rec * rec,
const char * name,
int64_t value )
related

Set the bin's value to an int64_t.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 644 of file as_rec.h.

References as_integer_new(), and as_util_hook.

◆ as_rec_set_integer()

static int as_rec_set_integer ( const as_rec * rec,
const char * name,
const as_integer * value )
related

Set the bin's value to an as_integer.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 692 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_list()

static int as_rec_set_list ( const as_rec * rec,
const char * name,
const as_list * value )
related

Set the bin's value to an as_list.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 772 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_map()

static int as_rec_set_map ( const as_rec * rec,
const char * name,
const as_map * value )
related

Set the bin's value to an as_map.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 788 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_str()

static int as_rec_set_str ( const as_rec * rec,
const char * name,
const char * value )
related

Set the bin's value to a NULL terminated string.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 676 of file as_rec.h.

References as_string_new_strdup(), and as_util_hook.

◆ as_rec_set_string()

static int as_rec_set_string ( const as_rec * rec,
const char * name,
const as_string * value )
related

Set the bin's value to an as_string.

Parameters
recThe as_rec storing the bin.
nameThe name of the bin.
valueThe value of the bin.
Returns
On success, 0. Otherwise an error occurred.

Definition at line 724 of file as_rec.h.

References as_util_hook.

◆ as_rec_set_ttl()

static int as_rec_set_ttl ( const as_rec * rec,
uint32_t ttl )
related

Set the time to live (ttl).

Definition at line 399 of file as_rec.h.

References as_util_hook.

◆ as_rec_setname()

static const char * as_rec_setname ( const as_rec * rec)
related

Get the record's set name.

Definition at line 359 of file as_rec.h.

References as_util_hook.

◆ as_rec_size()

static uint32_t as_rec_size ( const as_rec * rec)
related

Get the stored size (bytes) of the record

Definition at line 319 of file as_rec.h.

References as_util_hook.

◆ as_rec_source()

static void * as_rec_source ( const as_rec * rec)
related

Get the data source for the record.

Definition at line 263 of file as_rec.h.

References data.

◆ as_rec_toval()

static as_val * as_rec_toval ( const as_rec * rec)
related

Convert to an as_val.

Definition at line 822 of file as_rec.h.

◆ as_rec_ttl()

static uint32_t as_rec_ttl ( const as_rec * rec)
related

Get the ttl for the record.

Definition at line 289 of file as_rec.h.

References as_util_hook.

Field Documentation

◆ data

void* as_rec::data

Data provided by the implementation of as_rec.

Definition at line 86 of file as_rec.h.

◆ hooks

const struct as_rec_hooks_s* as_rec::hooks

Hooks provided by the implementation of as_rec.

Definition at line 91 of file as_rec.h.


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