Configure Aerospike Quick Look settings
This page describes the Aerospike Quick Look command to retrieve and specify settings for the tool’s environment. Some settings can be set using the command-line which is useful when you run a command without opening an interactive session by using the --command or -c option.
Retrieve a setting
To get the value of a setting, enter the following command where <setting> is the name of the setting:
get <setting>The following is an example of getting the setting for OUTPUT :
get outputOUTPUT = TABLETo set the value of a setting, enter the following command:
set <setting> <value>The command contains the following arguments:
<setting>: Name of the setting.<value>: New value for the setting.
The following is an example of setting OUTPUT=JSON.
set output jsonDURABLE_DELETE
Flag for setting policy value on the underlying C API calls used by DELETE, INSERT, EXECUTE, and SELECT (when doing a scan) operations. Available in Database 3.10 or later. Default is FALSE.
DURABLE_DELETE (TRUE | FALSE)The DURABLE_DELETE setting is available for a namespace that is running in strong consistency mode. In order to delete data from an strong consistency namespace, you likely need to perform a durable delete. Expunge deletes, which recover storage immediately at the cost of consistency, aren’t allowed by default, and result in a FORBIDDEN error. However, these deletes are the default in AQL.
This setting causes subsequent deletes in the same AQL session to be executed with the delete flag.
Since you can use AQL when first diagnosing and validating a configuration, be aware of the distinction between the following error codes:
PARTITION_UNAVAILABLEINVALID_NODE_ERRORTIMEOUTCONNECTION_ERROR
These error codes are described in Strong consistency.
The setting values that you set using AQL are valid only for the current session. When you start a new AQL session, the tool uses the default values.
ECHO
Echo commands. Also available using the --echo flag. Default is FALSE.
ECHO (TRUE | FALSE)KEY_SEND
Flag for sending the key to the server in read/write/delete commands. Default is TRUE.
KEY_SEND (TRUE | FALSE)LUA_USERPATH
Path to the user-managed Lua files. Also available using the --udfuser flag. Default is /opt/aerospike/usr/udf/lua.
LUA_USERPATH <path>NO_BINS
Flag for preventing bins from being queried. Default is FALSE, where no bins are included in a query result. Default is FALSE.
NO_BINS (TRUE | FALSE)OUTPUT
Output mode. Also available using the --output flag. Default is TABLE.
OUTPUT (TABLE | JSON | MUTE | RAW)TABLE is recommended for human readers, and JSON is recommended for machine readability.
OUTPUT_TYPES
Enable or disable printing (output mode) of type of the data value such as GeoJSON, LIST, MAP_KEY_ORDERED, and so on. Also available using the --outputtypes flag. Default is TRUE.
OUTPUT_TYPES (FALSE | TRUE)RECORD_TTL
Time, in seconds, that subsequently created or updated record live before being evicted by the server. Default is 0.
RECORD_TTL <seconds>RECORD_PRINT_METADATA
Enable printing of metadata (digest, ttl, generation) of the record. Valid only in JSON view. Default is FALSE, where metadata for records is printed.
RECORD_PRINT_METADATA (TRUE | FALSE)REPLICA_ANY
Flag for sending the primary key lookup request to all the replicas in round-robin manner, not just master.
REPLICA_ANY (TRUE | FALSE):::caution removed Option removed in AQL 7.0 and later. :::
SCAN_RECORDS_PER_SECOND
Flag for limiting the number of records returned per second for each server. Default is 0.
SCAN_RECORDS_PER_SECOND <rps_rate>SOCKET_TIMEOUT
Socket idle timeout in milliseconds for a query. Also available using the --socket-timeout flag. Default is -1.
SOCKET_TIMEOUT <milliseconds>TIMEOUT
Time, in milliseconds, to wait for a query to complete. Also available using the --timeout flag. Default is 1000.
TIMEOUT <milliseconds>VERBOSE
Enable verbose output. The output mode. Also available using the --verbose flag. Default is FALSE.
VERBOSE (TRUE | FALSE)