Source for file Interface.php

Documentation is available at Interface.php

  1. <?php
  2. /** 
  3.  *  PHP Version 5
  4.  *
  5.  *  @category    Amazon
  6.  *  @package     Amazon_SimpleDB
  7.  *  @copyright   Copyright 2008 Amazon Technologies, Inc.
  8.  *  @link        http://aws.amazon.com
  9.  *  @license     http://aws.amazon.com/apache2.0  Apache License, Version 2.0
  10.  *  @version     2007-11-07
  11.  */
  12. /******************************************************************************* 
  13.  *    __  _    _  ___ 
  14.  *   (  )( \/\/ )/ __)
  15.  *   /__\ \    / \__ \
  16.  *  (_)(_) \/\/  (___/
  17.  * 
  18.  *  Amazon Simple DB PHP5 Library
  19.  *  Generated: Thu Aug 28 06:20:51 PDT 2008
  20.  * 
  21.  */
  22. /**
  23.  * Amazon SimpleDB is a web service for running queries on structured
  24.  * data in real time. This service works in close conjunction with Amazon
  25.  * Simple Storage Service (Amazon S3) and Amazon Elastic Compute Cloud
  26.  * (Amazon EC2), collectively providing the ability to store, process
  27.  * and query data sets in the cloud. These services are designed to make
  28.  * web-scale computing easier and more cost-effective for developers.
  29.  * Traditionally, this type of functionality has been accomplished with
  30.  * a clustered relational database that requires a sizable upfront
  31.  * investment, brings more complexity than is typically needed, and often
  32.  * requires a DBA to maintain and administer. In contrast, Amazon SimpleDB
  33.  * is easy to use and provides the core functionality of a database -
  34.  * real-time lookup and simple querying of structured data without the
  35.  * operational complexity.  Amazon SimpleDB requires no schema, automatically
  36.  * indexes your data and provides a simple API for storage and access.
  37.  * This eliminates the administrative burden of data modeling, index
  38.  * maintenance, and performance tuning. Developers gain access to this
  39.  * functionality within Amazon's proven computing environment, are able
  40.  * to scale instantly, and pay only for what they use.
  41.  * 
  42.  */
  43.  
  44. interface  Amazon_SimpleDB_Interface 
  45. {
  46.     
  47.  
  48.             
  49.     /**
  50.      * Create Domain
  51.      * The CreateDomain operation creates a new domain. The domain name must be unique
  52.      * among the domains associated with the Access Key ID provided in the request. The CreateDomain
  53.      * operation may take 10 or more seconds to complete.
  54.      *   
  55.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_CreateDomain.html
  56.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_CreateDomainRequest request
  57.      *  or Amazon_SimpleDB_Model_CreateDomainRequest object itself
  58.      * @see Amazon_SimpleDB_Model_CreateDomainRequest
  59.      * @return Amazon_SimpleDB_Model_CreateDomainResponse Amazon_SimpleDB_Model_CreateDomainResponse
  60.      *
  61.      * @throws Amazon_SimpleDB_Exception
  62.      */
  63.     public function createDomain($request);
  64.  
  65.  
  66.             
  67.     /**
  68.      * List Domains
  69.      * The ListDomains operaton lists all domains associated with the Access Key ID. It returns
  70.      * domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more
  71.      * than MaxNumberOfDomains domains. Calling ListDomains successive times with the
  72.      * NextToken returns up to MaxNumberOfDomains more domain names each time.
  73.      *   
  74.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_ListDomains.html
  75.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_ListDomainsRequest request
  76.      *  or Amazon_SimpleDB_Model_ListDomainsRequest object itself
  77.      * @see Amazon_SimpleDB_Model_ListDomainsRequest
  78.      * @return Amazon_SimpleDB_Model_ListDomainsResponse Amazon_SimpleDB_Model_ListDomainsResponse
  79.      *
  80.      * @throws Amazon_SimpleDB_Exception
  81.      */
  82.     public function listDomains($request);
  83.  
  84.  
  85.             
  86.     /**
  87.      * Delete Domain
  88.      * The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain
  89.      * are deleted as well. The DeleteDomain operation may take 10 or more seconds to complete.
  90.      *   
  91.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_DeleteDomain.html
  92.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_DeleteDomainRequest request
  93.      *  or Amazon_SimpleDB_Model_DeleteDomainRequest object itself
  94.      * @see Amazon_SimpleDB_Model_DeleteDomainRequest
  95.      * @return Amazon_SimpleDB_Model_DeleteDomainResponse Amazon_SimpleDB_Model_DeleteDomainResponse
  96.      *
  97.      * @throws Amazon_SimpleDB_Exception
  98.      */
  99.     public function deleteDomain($request);
  100.  
  101.  
  102.             
  103.     /**
  104.      * Put Attributes
  105.      * The PutAttributes operation creates or replaces attributes within an item. You specify new attributes
  106.      * using a combination of the Attribute.X.Name and Attribute.X.Value parameters. You specify
  107.      * the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second
  108.      * attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.
  109.      * Attributes are uniquely identified within an item by their name/value combination. For example, a single
  110.      * item can have the attributes { "first_name", "first_value" } and { "first_name",
  111.      * second_value" }. However, it cannot have two attribute instances where both the Attribute.X.Name and
  112.      * Attribute.X.Value are the same.
  113.      * Optionally, the requestor can supply the Replace parameter for each individual value. Setting this value
  114.      * to true will cause the new attribute value to replace the existing attribute value(s). For example, if an
  115.      * item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor does a
  116.      * PutAttributes of { 'b', '4' } with the Replace parameter set to true, the final attributes of the
  117.      * item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute
  118.      * with the new value.
  119.      *   
  120.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_PutAttributes.html
  121.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_PutAttributesRequest request
  122.      *  or Amazon_SimpleDB_Model_PutAttributesRequest object itself
  123.      * @see Amazon_SimpleDB_Model_PutAttributesRequest
  124.      * @return Amazon_SimpleDB_Model_PutAttributesResponse Amazon_SimpleDB_Model_PutAttributesResponse
  125.      *
  126.      * @throws Amazon_SimpleDB_Exception
  127.      */
  128.     public function putAttributes($request);
  129.  
  130.  
  131.             
  132.     /**
  133.      * Get Attributes
  134.      * Returns all of the attributes associated with the item. Optionally, the attributes returned can be limited to
  135.      * the specified AttributeName parameter.
  136.      * If the item does not exist on the replica that was accessed for this operation, an empty attribute is
  137.      * returned. The system does not return an error as it cannot guarantee the item does not exist on other
  138.      * replicas.
  139.      *   
  140.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_GetAttributes.html
  141.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_GetAttributesRequest request
  142.      *  or Amazon_SimpleDB_Model_GetAttributesRequest object itself
  143.      * @see Amazon_SimpleDB_Model_GetAttributesRequest
  144.      * @return Amazon_SimpleDB_Model_GetAttributesResponse Amazon_SimpleDB_Model_GetAttributesResponse
  145.      *
  146.      * @throws Amazon_SimpleDB_Exception
  147.      */
  148.     public function getAttributes($request);
  149.  
  150.  
  151.             
  152.     /**
  153.      * Delete Attributes
  154.      * Deletes one or more attributes associated with the item. If all attributes of an item are deleted, the item is
  155.      * deleted.
  156.      *   
  157.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_DeleteAttributes.html
  158.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_DeleteAttributesRequest request
  159.      *  or Amazon_SimpleDB_Model_DeleteAttributesRequest object itself
  160.      * @see Amazon_SimpleDB_Model_DeleteAttributesRequest
  161.      * @return Amazon_SimpleDB_Model_DeleteAttributesResponse Amazon_SimpleDB_Model_DeleteAttributesResponse
  162.      *
  163.      * @throws Amazon_SimpleDB_Exception
  164.      */
  165.     public function deleteAttributes($request);
  166.  
  167.  
  168.             
  169.     /**
  170.      * Query
  171.      * The Query operation returns a set of ItemNames that match the query expression. Query operations that
  172.      * run longer than 5 seconds will likely time-out and return a time-out error response.
  173.      * A Query with no QueryExpression matches all items in the domain.
  174.      *   
  175.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_Query.html
  176.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_QueryRequest request
  177.      *  or Amazon_SimpleDB_Model_QueryRequest object itself
  178.      * @see Amazon_SimpleDB_Model_QueryRequest
  179.      * @return Amazon_SimpleDB_Model_QueryResponse Amazon_SimpleDB_Model_QueryResponse
  180.      *
  181.      * @throws Amazon_SimpleDB_Exception
  182.      */
  183.     public function query($request);
  184.  
  185.  
  186.             
  187.     /**
  188.      * Query With Attributes
  189.      * The QueryWithAttributes operation returns a set of item names and associated attributes.
  190.      * The query semantics of this operation are identical to the Query operation.
  191.      *   
  192.      * @see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/SDB_API_QueryWithAttributes.html
  193.      * @param mixed $request array of parameters for Amazon_SimpleDB_Model_QueryWithAttributesRequest request
  194.      *  or Amazon_SimpleDB_Model_QueryWithAttributesRequest object itself
  195.      * @see Amazon_SimpleDB_Model_QueryWithAttributesRequest
  196.      * @return Amazon_SimpleDB_Model_QueryWithAttributesResponse Amazon_SimpleDB_Model_QueryWithAttributesResponse
  197.      *
  198.      * @throws Amazon_SimpleDB_Exception
  199.      */
  200.     public function queryWithAttributes($request);
  201.  
  202. }

Documentation generated on Thu, 28 Aug 2008 06:35:49 -0700 by phpDocumentor 1.4.2