All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Macros | Enumerations | Functions
as_scan.h File Reference
#include <aerospike/as_bin.h>
#include <aerospike/as_key.h>
#include <aerospike/as_udf.h>
+ Include dependency graph for as_scan.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  as_scan
 
struct  as_scan_bins
 
struct  as_scan_info
 

Macros

#define AS_SCAN_CONCURRENT_DEFAULT   false
 
#define AS_SCAN_DESERIALIZE_DEFAULT   true
 
#define AS_SCAN_NOBINS_DEFAULT   false
 
#define AS_SCAN_PERCENT_DEFAULT   100
 
#define AS_SCAN_PRIORITY_DEFAULT   AS_SCAN_PRIORITY_AUTO
 
#define as_scan_select_inita(__scan, __n)
 

Enumerations

enum  as_scan_priority { AS_SCAN_PRIORITY_AUTO, AS_SCAN_PRIORITY_LOW, AS_SCAN_PRIORITY_MEDIUM, AS_SCAN_PRIORITY_HIGH }
 
enum  as_scan_status { AS_SCAN_STATUS_UNDEF, AS_SCAN_STATUS_INPROGRESS, AS_SCAN_STATUS_ABORTED, AS_SCAN_STATUS_COMPLETED }
 

Functions

bool as_scan_set_concurrent (as_scan *scan, bool concurrent)
 

Macro Definition Documentation

#define AS_SCAN_CONCURRENT_DEFAULT   false

Default value for as_scan.concurrent

Definition at line 50 of file as_scan.h.

#define AS_SCAN_DESERIALIZE_DEFAULT   true

Default value for as_scan.deserialize_list_map

Definition at line 55 of file as_scan.h.

#define AS_SCAN_NOBINS_DEFAULT   false

Default value for as_scan.no_bins

Definition at line 45 of file as_scan.h.

#define AS_SCAN_PERCENT_DEFAULT   100

Default value for as_scan.percent

Definition at line 40 of file as_scan.h.

#define AS_SCAN_PRIORITY_DEFAULT   AS_SCAN_PRIORITY_AUTO

Default value for as_scan.priority

Definition at line 35 of file as_scan.h.

#define as_scan_select_inita (   __scan,
  __n 
)
Value:
if ( (__scan) != NULL && (__scan)->select.entries == NULL ) {\
(__scan)->select.entries = (as_bin_name *) alloca(__n * sizeof(as_bin_name));\
if ( (__scan)->select.entries ) { \
(__scan)->select._free = false;\
(__scan)->select.capacity = __n;\
(__scan)->select.size = 0;\
}\
}
char as_bin_name[AS_BIN_NAME_MAX_SIZE]
Definition: as_bin.h:52

Initializes as_scan.select with a capacity of n using alloca

For heap allocation, use as_scan_select_init().

as_scan_select(&scan, "bin1");
as_scan_select(&scan, "bin2");
Parameters
__scanThe scan to initialize.
__nThe number of bins to allocate.

Definition at line 455 of file as_scan.h.

Enumeration Type Documentation

Priority levels for a scan operation.

Enumerator
AS_SCAN_PRIORITY_AUTO 

The cluster will auto adjust the scan priority.

AS_SCAN_PRIORITY_LOW 

Low priority scan.

AS_SCAN_PRIORITY_MEDIUM 

Medium priority scan.

AS_SCAN_PRIORITY_HIGH 

High priority scan.

Definition at line 64 of file as_scan.h.

The status of a particular background scan.

Enumerator
AS_SCAN_STATUS_UNDEF 

The scan status is undefined. This is likely due to the status not being properly checked.

AS_SCAN_STATUS_INPROGRESS 

The scan is currently running.

AS_SCAN_STATUS_ABORTED 

The scan was aborted. Due to failure or the user.

AS_SCAN_STATUS_COMPLETED 

The scan completed successfully.

Definition at line 91 of file as_scan.h.

Function Documentation

bool as_scan_set_concurrent ( as_scan scan,
bool  concurrent 
)

Scan all the nodes in prallel

Parameters
scanThe scan to set the concurrency on.
concurrentIf true, scan all the nodes in parallel
Returns
On success, true. Otherwise an error occurred.