Table Component
Properties Methods Events Configuration Settings Errors
The Table Component provides an easy interface to Microsoft's Windows Azure Table Service.
Syntax
nsoftware.InAzure.Table
Remarks
The table component allows you to easily access the Azure Table Service. You can use the component to create, modify, and delete tables, entities, and entity properties. A brief description follows, but please refer to Microsoft Azure Table Service Concepts for additional details on Azure Tables.
Before using the Table component you will first need to create an Azure Storage Account to obtain the AccessKey and Account
To begin you may add tables using the CreateTable method. Entities may be created using InsertEntity method. Entities are identified within a table by the PartitionKey and RowKey. Methods relating to entities will take partitionKey and rowKey as parameters. For instance to update an entity:
table.Reset(); table.TableName = "YourTableName"; table.AccessKey = "YourAccessKey"; table.Account = "YourAccount"; //Get the existing properties of an entity in a table table.GetEntity("MyPartionKey","MyRowKey"); //Output the value of the 1st entity Console.WriteLine(table.EntityProperties[0].Value); //Change the Entity value table.EntityProperties[0].Value = "NewValue"; //Add a new Entity property table.AddEntityProperty("testString", 7, "My New String"); //Update the entity table.UpdateEntity();
Additional methods and properties can be used for further operations on tables, such as DeleteTable DeleteEntity InsertEntity MergeEntity etc.
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 Windows Azure access key. |
Account | The Windows Azure storage account name. |
Connected | Shows whether the component is connected. |
EntityCount | Returns the number of entities in the response from the server. |
EntityETag | Gets the etag of the current entity. |
EntityIndex | Indicates the index of the current entity. |
EntityLastModified | Gets the last modification date of the current entity. |
EntityPartitionKey | Gets the partition key of the current entity. |
EntityProperties | The list of entity properties of current entity. |
EntityRowKey | Gets the row key of the current entity. |
EntityURL | Gets the URL of the current entity. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | Determines what happens when the server issues a redirect. |
Idle | The current status of the component. |
IfMatch | Specifies the condition for which the update/merge/delete should be performed. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
NextPartitionKey | Indicates the next partition key to be returned in a subsequent query against the table. |
NextRowKey | Indicates the next row key to be returned in a subsequent query against the table. |
NextTableName | Indicates the name of the next table in the list, if the list of tables returned is not complete. |
OtherHeaders | Other headers as determined by the user (optional). |
ParsedHeaders | Collection of headers returned from the last request. |
Proxy | A set of properties related to proxy access. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
StatusLine | The first line of the last server response. |
TableName | The name of current table. |
Tables | The list of tables returned by a call to ListTables . |
Timeout | A timeout for the component. |
UseSSL | Use SSL to access Azure Blob. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddEntityProperty | Adds an entity property that will be used for inserting, updating or merging an entity. |
Config | Sets or retrieves a configuration setting . |
CreateTable | Creates a new table within a storage account. |
DeleteEntity | Deletes an entity within a table. |
DeleteTable | Deletes a table from a storage account. |
DoEvents | Processes events from the internal message queue. |
GetEntity | Gets the entity specified by PartitionKey and RowKey. |
InsertEntity | Inserts a new entity into a table. |
Interrupt | Interrupt the current method. |
ListEntities | Lists the entities in a table. |
ListTables | Lists the tables in a storage account. |
MergeEntity | Updates an existing entity within a table by merging new property values into the entity. |
Reset | Resets request-related properties. |
ResetHeaders | Resets all HTTP headers, cookies, and localfile. |
UpdateEntity | Updates an existing entity within a table by replacing it. |
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.
Connected | Fired immediately after a connection completes (or fails). |
Disconnected | Fired when a connection is closed. |
EndTransfer | Fired when a document finishes transferring. |
EntityList | Fired for every entity when ListEntities is called. |
Error | Information about errors during data delivery. |
Header | Fired every time a header line comes in. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Status | Fired when the HTTP status line is received from the server. |
TableList | Fired for every table when ListTables is called. |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
APIVersion | The API version specified in the request. |
TransferredData | Returns the entire XML response received from Azure. |
URL | If set, the default URL(http://youraccount.blob.core.windows.net/) will be overridden by this value. |
AzureTimeout | Gets or sets the service timeout for the request in seconds. |
DateFormat | The format string to be used for formatting the DateTime values received from the server. |
QueryString | Filters the returned results based on provided string properties. |
XMLEscapeProperties | Whether entity property names and values are XML escaped. |
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. |