SimpleDB Component
Properties Methods Events Configuration Settings Errors
The SimpleDB Component provides an easy interface to Amazon's SimpleDB.
Syntax
TibaSimpleDB
Remarks
The SimpleDB Component allows you to access Amazon's SimpleDB. SimpleDB allows you to create globally accessible databases on Amazon's servers. These databases can be used by developers to transfer data between distributed applications and store information. A brief synopsis follows, but please refer to Amazon SimpleDB documentation for details.
You will first need to sign up for the SimpleDB service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating domains in your account using CreateDomain. You can then start adding items and attributes to the queue using PutAttributes and retrieve the same using Select.
There are other methods such as ListDomains, DeleteDomain, DeleteAttributes etc. that further enable you to manage your SimpleDB domains and items.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| AttributesCount | The number of records in the Attributes arrays. |
| AttributesName | The name of the attribute. |
| AttributesReplace | Whether or not an attribute is replaced. |
| AttributesValue | The value of the attribute. |
| DomainName | The domain name to use for all operations. |
| DomainCount | The number of records in the Domain array. |
| Domain | A list of domains for an account. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| ItemCount | The number of records in the Item arrays. |
| ItemAttrCount | Number of attributes for the current item. |
| ItemAttrIndex | The index of the selected attribute of the current item. |
| ItemAttrName | The name of the attribute selected by AttrIndex . |
| ItemAttrReplace | The replace flag of the attribute selected by AttrIndex . |
| ItemAttrValue | The value of the attribute selected by AttrIndex . |
| ItemName | The name of the SimpleDB item. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| NextToken | Allows one to set the value to start searching for the next query while calling ListDomains or Select . |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| StatusLine | The first line of the last server response. |
| Timeout | A timeout for the component. |
| UseSSL | Use SSL to access Amazon SimpleDB. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| BatchPutAttributes | Performs a BatchPutAttributes operation. |
| Config | Sets or retrieves a configuration setting . |
| CreateDomain | Creates a SimpleDB domain. |
| DeleteAttributes | Deletes the current collection of Attributes in the domain specified by DomainName and the parameter ItemName . |
| DeleteDomain | Deletes a SimpleDB domain. |
| DoEvents | Processes events from the internal message queue. |
| GetAttributes | Retrieves the current collection of Attributes from the domain specified by DomainName and the parameter ItemName . |
| GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
| Interrupt | Interrupt the current method. |
| ListDomains | Lists the SimpleDB domains of the specified account. |
| PutAttributes | Puts the current collection of Attributes to the domain specified by DomainName and the parameter ItemName . |
| Reset | Resets request-related properties. |
| ResetAttributes | Resets the entire attribute collection. |
| Select | Performs a select query on a SimpleDB Domain. |
| SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Attribute | Fired after an attribute is retrieved from the specified Item while calling GetAttributes . |
| Domain | Fired for each domain of the user. |
| Error | Information about errors during data delivery. |
| Item | Fired for each valid item name that is returned after a call to Select . |
| Metadata | Fired when valid Amazon metadata is returned after a SimpleDB method call. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| MaxNumberOfDomains | The maximum number of domains to retrieve while listing domains. |
| Region | The regional endpoint to use for requests. |
| APIVersion | Amazon's API version. |
| HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
| SignCustomRequest | Tells the component to sign the outgoing request. |
| TransferredData | Returns the entire XML response received from Amazon. |
| URL | If set, the default URL will be overridden by this value. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |