Amazon SDB

Amazon SimpleDB Service (http://aws.amazon.com/simpledb)

Version

2009.08.23

Copyright

2006-2010 Ryan Parman, Foleeo, Inc., and contributors.

License

Simplified BSD Licensehttp://opensource.org/licenses/bsd-license.php

See Also

CloudFusionhttp://getcloudfusion.com
Amazon SDBhttp://aws.amazon.com/simpledb

Constants

SDB_DEFAULT_URL

Specify the default queue URL.

AmazonSDB

Container for all Amazon SimpleDB-related methods.  Inherits additional methods from CloudFusion.

Extends

CloudFusion

Functions

__construct()

public function __construct($key =  null,
$secret_key =  null)

The constructor

Access

public

Parameters

keystring (Optional) Your Amazon API Key.  If blank, it will look for the AWS_KEY constant.
secret_keystring (Optional) Your Amazon API Secret Key.  If blank, it will look for the AWS_SECRET_KEY constant.

Returns

boolean false if no valid values are set, otherwise true.

create_domain()

public function create_domain($domain_name,  
$returnCurlHandle =  null)

Creates a new domain.  The domain name must be unique among the domains associated with the Access Key ID provided in the request.  The CreateDomain operation might take 10 or more seconds to complete.

Access

public

Parameters

domain_namestring (Required) The domain name to use for storing data.
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::create_domain
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->create_domain('warpshare-unit-test');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_CreateDomain.html
Relatedcreate_domain(), list_domains(), delete_domain(), domain_metadata()

list_domains()

public function list_domains($opt =  null)

Lists all domains associated with the Access Key ID.  It returns domain names up to the limit set by MaxNumberOfDomains.  A NextToken is returned if there are more than MaxNumberOfDomains domains.  Calling ListDomains successive times with the NextToken returns up to MaxNumberOfDomains more domain names each time.

Access

public

Parameters

optarray (Required) Associative array of parameters which can have the following keys:

Keys for the $opt parameter

MaxNumberOfDomainsinteger (Optional) The maximum number of domain names you want returned.  The range is 1 to 100.
NextTokenstring (Optional) String that tells Amazon SimpleDB where to start the next list of domain names.
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::list_domains
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->list_domains();

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::list_domains MaxNumberOfDomains
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->list_domains(array(
	'MaxNumberOfDomains' => 1
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::list_domains NextToken
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->list_domains(array(
	'NextToken' => 't'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::list_domains MaxNumberOfDomains + NextToken
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->list_domains(array(
	'MaxNumberOfDomains' => 1,
	'NextToken' => 't'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_ListDomains.html
Relatedcreate_domain(), list_domains(), delete_domain(), domain_metadata()

delete_domain()

public function delete_domain($domain_name,  
$returnCurlHandle =  null)

Deletes a domain.  Any items (and their attributes) in the domain are deleted as well.  The DeleteDomain operation might take 10 or more seconds to complete.  Running DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response.

Access

public

Parameters

domain_namestring (Required) The domain name to delete.
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::delete_attributes
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::delete_attributes single
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test', 'key1');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::delete_attributes multiple
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test', array(
	'key2' => 'value1'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::delete_attributes key-value pair
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test', array(
	'key2',
	'key3'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_DeleteDomain.html
Relatedcreate_domain(), list_domains(), delete_domain(), domain_metadata()

domain_metadata()

public function domain_metadata($domain_name,  
$returnCurlHandle =  null)

Returns information about the domain, including when the domain was created, the number of items and attributes, and the size of attribute names and values.

Access

public

Parameters

domain_namestring (Required) The domain name to use for retrieving metadata.
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::domain_metadata
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->domain_metadata('warpshare-unit-test');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_DomainMetadata.html
Relatedcreate_domain(), list_domains(), delete_domain(), domain_metadata()

put_attributes()

public function put_attributes($domain_name,  
$item_name,  
$keypairs,  
$replace =  null,
$returnCurlHandle =  null)

Creates or replaces attributes in an item.  You specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters.

Access

public

Parameters

domain_namestring (Required) The domain name to use for storing data.
item_namestring (Required) The name of the base item which will contain the series of keypairs.
keypairsarray (Required) Associative array of parameters which are treated as key-value and key-multivalue pairs (i.e. a key can have one or more values; think tags).
replaceboolean|array (Optional) Whether to replace a key-value pair if a matching key already exists.  Supports either a boolean (which affects ALL key-value pairs) or an indexed array of key names (which affects only the keys specified).  Defaults to boolean false.
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::put_attributes
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->put_attributes('warpshare-unit-test', 'unit-test', array(
	'key1' => 'value1',
	'key2' => array(
		'value1',
		'value2',
		'value3'
	)
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::put_attributes replace
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->put_attributes('warpshare-unit-test', 'unit-test', array(
	'key1' => 'value1',
	'key2' => array(
		'value1',
		'value2',
		'value3'
	)
), true);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::put_attributes selective replace
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->put_attributes('warpshare-unit-test', 'unit-test', array(
	'key1' => 'value1',
	'key2' => array(
		'value1',
		'value2',
		'value3'
	)
), array('key1'));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_PutAttributes.html
Relatedget_attributes(), delete_attributes()

batch_put_attributes()

public function batch_put_attributes($domain_name,  
$item_keypairs,  
$replace =  null,
$returnCurlHandle =  null)

Creates or replaces attributes in an item.  You specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters.

Access

public

Parameters

domain_namestring (Required) The domain name to use for storing data.
item_keypairsarray (Required) Associative array of parameters which are treated as item-key-value and item-key-multivalue pairs (i.e. a key can have one or more values; think tags).
replaceboolean|array (Optional) Whether to replace a key-value pair if a matching key already exists.  Supports either a boolean (which affects ALL key-value pairs) or an indexed array of key names (which affects only the keys specified).  Defaults to boolean false.
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::batch_put_attributes
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();

// Test data
$response = $sdb->batch_put_attributes('warpshare-unit-test', array(
	'item1' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
	'item2' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
	'item3' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::batch_put_attributes with replace all
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();

// Test data
$response = $sdb->batch_put_attributes('warpshare-unit-test', array(
	'item1' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
	'item2' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
	'item3' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
), true);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::batch_put_attributes with replace specific
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();

// Test data
$response = $sdb->batch_put_attributes('warpshare-unit-test', array(
	'item1' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
	'item2' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
	'item3' => array(
		'key1' => 'value1',
		'key2' => array(
			'value1',
			'value2',
			'value3',
		),
		'key3' => array('value1'),
	),
), array(
	'item1' => array(
		'key2'
	),
	'item3' => array(
		'key3'
	),
));
$url = $response->header['_info']['url'];

// Are these stored in the URL properly?
var_dump((stristr($url, 'Item.0.Attribute.0.Replace') !== false) ? true : false);
var_dump((stristr($url, 'Item.0.Attribute.1.Replace') !== false) ? true : false);
var_dump((stristr($url, 'Item.0.Attribute.2.Replace') !== false) ? true : false);
var_dump((stristr($url, 'Item.0.Attribute.3.Replace') !== false) ? true : false);
var_dump((stristr($url, 'Item.2.Attribute.5.Replace') !== false) ? true : false);

/** [Expected output] 
bool(false)
bool(true)
bool(true)
bool(true)
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_PutAttributes.html
Relatedget_attributes(), delete_attributes()

get_attributes()

public function get_attributes($domain_name,  
$item_name,  
$keys =  null,
$returnCurlHandle =  null)

Returns all of the attributes associated with the item.  Optionally, the attributes returned can be limited to one or more specified attribute name parameters.  If the item does not exist on the replica that was accessed for this operation, an empty set is returned.  The system does not return an error as it cannot guarantee the item does not exist on other replicas.

Access

public

Parameters

domain_namestring (Required) The domain name to use for storing data.
item_namestring (Required) The name of the base item which will contain the series of keypairs.
keysstring|array (Optional) The name of the key (attribute) in the key-value pair that you want to return.  Supports a string value (for single keys) or an indexed array (for multiple keys).
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::get_attributes
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->get_attributes('warpshare-unit-test', 'unit-test');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::get_attributes specific key
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->get_attributes('warpshare-unit-test', 'unit-test', array(
	'key1'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::get_attributes specific key string
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->get_attributes('warpshare-unit-test', 'unit-test', 'key1');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_GetAttributes.html
Relatedput_attributes(), delete_attributes()

delete_attributes()

public function delete_attributes($domain_name,  
$item_name,  
$keys =  null,
$returnCurlHandle =  null)

Deletes one or more attributes associated with the item.  If all attributes of an item are deleted, the item is deleted.  If you specify DeleteAttributes without attributes or values, all the attributes for the item are deleted.  DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Access

public

Parameters

domain_namestring (Required) The domain name to use for storing data.
item_namestring (Required) The name of the base item which will contain the series of keypairs.
keysstring|array (Optional) The name of the key (attribute) in the key-value pair that you want to delete.  Supports a string value (for single keys), an indexed array (for multiple keys), or an associative array containing one or more key-value pairs (for deleting specific values).
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::delete_attributes
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::delete_attributes single
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test', 'key1');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::delete_attributes multiple
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test', array(
	'key2' => 'value1'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::delete_attributes key-value pair
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_attributes('warpshare-unit-test', 'unit-test', array(
	'key2',
	'key3'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_DeleteAttributes.html
Relatedput_attributes(), get_attributes()

select()

public function select($expression,  
$opt =  null)

The Select operation returns a set of Attributes for ItemNames that match the query expression.  Select is similar to the standard SQL SELECT statement.

The total size of the response cannot exceed 1 MB in total size.  Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit.  For example, even if you ask to retrieve 250 items, but each individual item is 100 kB in size, the system returns 10 items and an appropriate next token so you can get the next page of results.

Access

public

Parameters

expressionstring (Optional) The SimpleDB select expression to use.
optarray (Optional) Associative array of parameters which can have the following keys:

Keys for the $opt parameter

NextTokenstring (Optional) String that tells Amazon SimpleDB where to start the next list of domain names.
returnCurlHandleboolean (Optional) A private toggle that will return the CURL handle for the request rather than actually completing the request.  This is useful for MultiCURL requests.

Returns

ResponseCore object

Examples

AmazonSDB::select
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->select('SELECT * FROM `warpshare-unit-test`');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>
AmazonSDB::select NextToken
<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->select('SELECT * FROM `warpshare-unit-test`', array(
	'NextToken' => 't'
));

// Success?
var_dump($response->body->Errors->Error->Code);

/** [Expected output] 
object(SimpleXMLElement)#6 (1) {
  [0]=>
  string(16) "InvalidNextToken"
}*/
?>

See Also

AWS Methodhttp://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API_Select.html
Relatedselect()