apiref_kv.md

Key-Value Methods

Aerospike::getKeyDigest

public string Aerospike::getKeyDigest (string $ns, string $set, string|int $pk)

Aerospike::initKey

public array Aerospike::initKey ( string $ns, string $set, int|string $pk [, boolean $is_digest = false ] )

Aerospike::getKeyDigest

public string Aerospike::getKeyDigest ( string $ns, string $set, int|string $pk )

Aerospike::put

public int Aerospike::put ( array $key, array $bins [, int $ttl = 0 [, array $options ]] )

Aerospike::get

public int Aerospike::get ( array $key, array &$record [, array $filter [, array $options ]] )

Aerospike::remove

public int Aerospike::remove ( array $key [, array $options ] )

Aerospike::removeBin

public int Aerospike::removeBin ( array $key, array $bins [, array $options ] )

Aerospike::exists

public int Aerospike::exists ( array $key, array &$metadata [, array $options ] )
public int Aerospike::getMetadata ( array $key, array &$metadata [, array $options ] )

Aerospike::touch

public int Aerospike::touch ( array $key, int $ttl = 0 [, array $options ] )

Aerospike::increment

public int Aerospike::increment ( array $key, string $bin, int $offset [, array $options ] )

Aerospike::append

public int Aerospike::append ( array $key, string $bin, string $value [, array $options ] )

Aerospike::prepend

public int Aerospike::prepend ( array $key, string $bin, string $value [, array $options ] )

Aerospike::operate

public int Aerospike::operate ( array $key, array $operations [, array &$returned ] )

Aerospike::getMany

public int Aerospike::getMany ( array $keys, array &$records [, array $filter [, array $options]] )

Aerospike::existsMany

public int Aerospike::existsMany ( array $keys, array &$metadata [, array $options ] )

Aerospike::listSize

// count the elements of the list value in the bin
public int Aerospike::listSize ( array $key, string $bin, int &$count [, array $options ] )

Aerospike::listAppend

// add a single value (of any type) to the end of the list
public int Aerospike::listAppend ( array $key, string $bin, mixed $value [, array $options ] )

Aerospike::listMerge

// add items to the end of a list
public int Aerospike::listMerge ( array $key, string $bin, array $items [, array $options ] )

Aerospike::listInsert

// insert an element at the specified index of a list value in the bin
public int Aerospike::listInsert ( array $key, string $bin, int $index, mixed $value [, array $options ] )

Aerospike::listInertItems

// insert items at the specified index of a list value in the bin
public int Aerospike::listInertItems ( array $key, string $bin, int $index, array $items [, array $options ] )

Aerospike::listPop

// remove and get back the list element at a given index of a list value in the bin
// index -1 is the last item in the list, -3 is the third from last, 0 is the first in the list
public int Aerospike::listPop ( array $key, string $bin, int $index, mixed &$element [, array $options ] )

Aerospike::listPopRange

// remove and get back list elements at a given index of a list value in the bin
public int Aerospike::listPopRange ( array $key, string $bin, int $index, int $count, array &$elements [, array $options ] )

Aerospike::listRemove

// remove a list element at a given index of a list value in the bin
public int Aerospike::listRemove ( array $key, string $bin, int $index [, array $options ] )

Aerospike::listRemoveRange

// remove list elements at a given index of a list value in the bin
public int Aerospike::listRemoveRange ( array $key, string $bin, int $index, int $count [, array $options ] )

Aerospike::listTrim

// trim the list, removing all elements not in the range starting at a given index plus count
public int Aerospike::listTrim ( array $key, string $bin, int $index, int $count [, array $options ] )

Aerospike::listClear

// remove all the elements from the list value in the bin
public int Aerospike::listClear ( array $key, string $bin [, array $options ] )

Aerospike::listSet

// set list element val at the specified index of a list value in the bin
public int Aerospike::listSet ( array $key, string $bin, int $index, mixed $val [, array $options ] )

Aerospike::listGet

// get the list element at the specified index of a list value in the bin
public int Aerospike::listGet ( array $key, string $bin, int $index, mixed &$element [, array $options ] )

Aerospike::listGetRange

// get the list of $count elements starting at a specified index of a list value in the bin
public int Aerospike::listGetRange ( array $key, string $bin, int $index, int $count, array &$elements [, array $options ] )

Aerospike::setSerializer

public static Aerospike::setSerializer ( callback $serialize_cb )

Aerospike::setDeserializer

public static Aerospike::setDeserializer ( callback $unserialize_cb )

Example

<?php

$config = ["hosts" => [["addr"=>"localhost", "port"=>3000]], "shm"=>[]];
$client = new Aerospike($config, true);
if (!$client->isConnected()) {
   echo "Aerospike failed to connect[{$client->errorno()}]: {$client->error()}\n";
   exit(1);
}

$key = $client->initKey("test", "users", 1234);
$bins = ["email" => "hey@example.com", "name" => "Hey There"];
// attempt to 'CREATE' a new record at the specified key
$status = $client->put($key, $bins, 0, [Aerospike::OPT_POLICY_EXISTS => Aerospike::POLICY_EXISTS_CREATE]);
if ($status == Aerospike::OK) {
    echo "Record written.\n";
} elseif ($status == Aerospike::ERR_RECORD_EXISTS) {
    echo "The Aerospike server already has a record with the given key.\n";
} else {
    echo "[{$client->errorno()}] ".$client->error();
}

// check for the existance of the given key in the database, then fetch it
if ($client->exists($key, $foo) == Aerospike::OK) {
    $status = $client->get($key, $record);
    if ($status == Aerospike::OK) {
        var_dump($record);
    }
}

// filtering for specific keys
$status = $client->get($key, $record, ["email"], Aerospike::POLICY_RETRY_ONCE);
if ($status == Aerospike::OK) {
    echo "The email for this user is ". $record['bins']['email']. "\n";
    echo "The name bin should be filtered out: ".var_export(is_null($record['bins']['name']), true). "\n";
}
?>