All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Fields | Related Functions
as_batch_read_record Struct Reference

Detailed Description

Key and bin names used in batch commands where variables bins are needed for each key. The returned records are located in the same batch record.

Definition at line 54 of file aerospike_batch.h.

#include "aerospike_batch.h"

+ Collaboration diagram for as_batch_read_record:

Data Fields

char ** bin_names
 
as_key key
 
uint32_t n_bin_names
 
bool read_all_bins
 
as_record record
 
as_status result
 

Related Functions

(Note that these are not member functions.)

void as_batch_read_destroy (as_batch_read_records *records)
 
static void as_batch_read_init (as_batch_read_records *records, uint32_t capacity)
 
#define as_batch_read_inita(__records, __capacity)   as_vector_inita(&((__records)->list), sizeof(as_batch_read_record), __capacity);
 
static as_batch_read_recordas_batch_read_reserve (as_batch_read_records *records)
 

Friends And Related Function Documentation

#define as_batch_read_inita (   __records,
  __capacity 
)    as_vector_inita(&((__records)->list), sizeof(as_batch_read_record), __capacity);
related

Initialize as_batch_read_records with specified capacity on the stack using alloca().

When the batch is no longer needed, then use as_batch_destroy() to release the batch and associated resources.

Parameters
__recordsBatch record list.
__capacityInitial capacity of batch record list. List will resize when necessary.

Definition at line 160 of file aerospike_batch.h.

Field Documentation

char** as_batch_read_record::bin_names

Bin names requested for this key.

Definition at line 63 of file aerospike_batch.h.

as_key as_batch_read_record::key

The key requested.

Definition at line 58 of file aerospike_batch.h.

uint32_t as_batch_read_record::n_bin_names

Count of bin names requested for this key.

Definition at line 68 of file aerospike_batch.h.

bool as_batch_read_record::read_all_bins

If true, ignore bin_names and read all bins. If false and bin_names are set, read specified bin_names. If false and bin_names are not set, read record header (generation, expiration) only.

Definition at line 75 of file aerospike_batch.h.

as_record as_batch_read_record::record

The record for the key requested. For "exists" calls, the record will never contain bins but will contain metadata (generation and expiration) when the record exists.

Definition at line 99 of file aerospike_batch.h.

as_status as_batch_read_record::result

The result of the read transaction.

Values:

  • AEROSPIKE_OK: record found
  • AEROSPIKE_ERR_RECORD_NOT_FOUND: record not found
  • Other: transaction error code

Definition at line 93 of file aerospike_batch.h.


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