SimpleDB adapter for document service.
Provides functionality surrounding setting classes for each of:
category | Zend |
---|---|
package | Zend_Cloud |
subpackage | DocumentService |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Cloud_DocumentService_Adapter_AbstractAdapter |
__construct(array $options = array()
) : void
array
_validateFieldKey(string $key) : void
Since Azure uses Atom, and fieldnames are included as part of XML element tag names, the field names must be valid XML names.
While we could potentially normalize names, this could also lead to conflict with other field names -- which we should avoid. As such, invalid field names will raise an exception.
string
\Zend_Cloud_DocumentService_Exception |
---|
_validateFields(\Zend_Cloud_DocumentService_Document|array $document) : void
Since Azure uses Atom, and fieldnames are included as part of XML element tag names, the field names must be valid XML names.
\Zend_Cloud_DocumentService_Document
array
\Zend_Cloud_DocumentService_Exception |
---|
createCollection(string $name, array $options = null
) : boolean
string
array
boolean
deleteCollection(string $name, array $options = null
) : boolean
string
array
boolean
deleteDocument($collectionName, $documentId, array $options = null
) : void
array
fetchDocument(string $collectionName, mixed $documentId, array $options = null
) : \Zend_Cloud_DocumentService_Document
string
Collection name
mixed
Document ID, adapter-dependent
array
\Zend_Cloud_DocumentService_Document
getClient() : \Zend_Service_WindowsAzure_Storage_Table
\Zend_Service_WindowsAzure_Storage_Table
getDefaultPartitionKey() : null | string
null
string
getDocumentClass() : string
string
getDocumentSetClass() : string
string
getQueryClass() : string
string
insertDocument($collectionName, array|\Zend_Cloud_DocumentService_Document $document, array $options = null
) : boolean
array
\Zend_Cloud_DocumentService_Document
array
boolean
listCollections(array $options = null
) : array
array
array
listDocuments(string $collectionName, null|array $options = null
) : \Zend_Cloud_DocumentService_DocumentSet
string
null
array
\Zend_Cloud_DocumentService_DocumentSet
query(string $collectionName, string|\Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query $query, array $options = null
) : array
string
Collection name
string
\Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query
array
array
Zend_Cloud_DocumentService_DocumentSetreplaceDocument($collectionName, \Zend_Cloud_DocumentService_Document $document, array $options = null
) : boolean
The new document replaces the existing document.
\Zend_Cloud_DocumentService_Document
array
boolean
select($fields = null
) : \Zend_Cloud_DocumentService_Query
\Zend_Cloud_DocumentService_Query
setDefaultPartitionKey(string $key) : \Zend_Cloud_DocumentService_Adapter_WindowsAzure
string
\Zend_Cloud_DocumentService_Adapter_WindowsAzure
setDocumentClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter
string
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter
setDocumentSetClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter
string
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter
setQueryClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter
string
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter
updateDocument(string $collectionName, mixed|\Zend_Cloud_DocumentService_Document $documentId, $fieldset= null
, array $options= null
) : boolean
The new document is merged the existing document.
string
mixed
\Zend_Cloud_DocumentService_Document
Document identifier or document contaiing updates
array
boolean
_getDocumentFromArray(array $document, null|string $collectionName = null
) : \Zend_Cloud_DocumentService_Document
array
null
string
Collection to which this document belongs
\Zend_Cloud_DocumentService_Document
_resolveAttributes(\Zend_Service_WindowsAzure_Storage_TableEntity $entity) : array
\Zend_Service_WindowsAzure_Storage_TableEntity
array
_validateCompositeKey(array $key) : \throws
array
\throws
Zend_Cloud_DocumentService_Exception_validateDocumentId(array|string $documentId, null|string $collectionName = false
) : array
If the identifier is an array containing a valid partition and row key, returns it. If the identifier is a string:
array
string
null
string
\Zend_Cloud_DocumentService_Exception |
---|
array
_validateKey(string $key) : void
string
\Zend_Cloud_DocumentService_Exception |
---|
$_defaultPartitionKey : string
$_documentClass : string
'Zend_Cloud_DocumentService_Document'
$_documentSetClass : string
'Zend_Cloud_DocumentService_DocumentSet'
$_queryClass : string
'Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query'
inherited_from | \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::_queryClass |
---|
$_queryClass : string
'Zend_Cloud_DocumentService_Query'
$_storageClient : \Zend_Service_WindowsAzure_Storage_Table
ACCOUNT_KEY = 'storage_accountkey'
ACCOUNT_NAME = 'storage_accountname'
DEFAULT_HOST = \Zend_Service_WindowsAzure_Storage::URL_CLOUD_TABLE
DEFAULT_PARTITION_KEY = "default_partition_key"
DEFAULT_QUERY_CLASS = 'Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query'
DOCUMENTSET_CLASS = 'documentset_class'
DOCUMENT_CLASS = 'document_class'
HOST = "storage_host"
PARTITION_KEY = 'PartitionKey'
PROXY_CREDENTIALS = "storage_proxy_credentials"
PROXY_HOST = "storage_proxy_host"
PROXY_PORT = "storage_proxy_port"
QUERY_CLASS = 'query_class'
ROW_KEY = 'RowKey'
TIMESTAMP_KEY = "Timestamp"
VERIFY_ETAG = "verify_etag"