Azure Integrator V2 - Online Help
Azure Integrator V2
Questions / Feedback?

Table Class

Properties   Methods   Events   Configuration Settings   Errors  

The Table Component provides an easy interface to Microsoft's Windows Azure Table Service.

Class Name

InAzure_Table

Procedural Interface

 inazure_table_open();
 inazure_table_close($res);
 inazure_table_register_callback($res, $id, $function);
 inazure_table_get_last_error($res);
 inazure_table_get_last_error_code($res);
 inazure_table_set($res, $id, $index, $value);
 inazure_table_get($res, $id, $index);
 inazure_table_do_addentityproperty($res, $name, $valuetype, $value);
 inazure_table_do_config($res, $configurationstring);
 inazure_table_do_createtable($res);
 inazure_table_do_deleteentity($res, $partitionkey, $rowkey);
 inazure_table_do_deletetable($res);
 inazure_table_do_doevents($res);
 inazure_table_do_getentity($res, $partitionkey, $rowkey);
 inazure_table_do_insertentity($res, $partitionkey, $rowkey);
 inazure_table_do_interrupt($res);
 inazure_table_do_listentities($res);
 inazure_table_do_listtables($res);
 inazure_table_do_mergeentity($res);
 inazure_table_do_reset($res);
 inazure_table_do_resetheaders($res);
 inazure_table_do_updateentity($res);

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 "MyPartitionKey","MyRowKey" 

'Output the value of the 1st entity
Debug.Print(table.EntityPropertiesValue(0))

'Change the Entity value
table.EntityPropertiesValue(0) = "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 class with short descriptions. Click on the links for further details.

AccessKeyThe Windows Azure access key.
AccountThe Windows Azure storage account name.
ConnectedShows whether the component is connected.
EntityCountReturns the number of entities in the response from the server.
EntityETagGets the etag of the current entity.
EntityIndexIndicates the index of the current entity.
EntityLastModifiedGets the last modification date of the current entity.
EntityPartitionKeyGets the partition key of the current entity.
EntityPropertiesCountThe number of records in the EntityProperties arrays.
EntityPropertiesNameThe name of the entity property.
EntityPropertiesTypeThe type of the entity property.
EntityPropertiesValueThe value of the entity property.
EntityRowKeyGets the row key of the current entity.
EntityURLGets the URL of the current entity.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the component.
IfMatchSpecifies the condition for which the update/merge/delete should be performed.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NextPartitionKeyIndicates the next partition key to be returned in a subsequent query against the table.
NextRowKeyIndicates the next row key to be returned in a subsequent query against the table.
NextTableNameIndicates the name of the next table in the list, if the list of tables returned is not complete.
OtherHeadersOther headers as determined by the user (optional).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StatusLineThe first line of the last server response.
TableNameThe name of current table.
TablesCountThe number of records in the Tables arrays.
TablesLastModifiedThe last modified time of the table.
TablesNameThe name of the table.
TablesURLThe URL of the table.
TimeoutA timeout for the component.
UseSSLUse SSL to access Azure Blob.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddEntityPropertyAdds an entity property that will be used for inserting, updating or merging an entity.
ConfigSets or retrieves a configuration setting .
CreateTableCreates a new table within a storage account.
DeleteEntityDeletes an entity within a table.
DeleteTableDeletes a table from a storage account.
DoEventsProcesses events from the internal message queue.
GetEntityGets the entity specified by PartitionKey and RowKey.
InsertEntityInserts a new entity into a table.
InterruptInterrupt the current method.
ListEntitiesLists the entities in a table.
ListTablesLists the tables in a storage account.
MergeEntityUpdates an existing entity within a table by merging new property values into the entity.
ResetResets request-related properties.
ResetHeadersResets all HTTP headers, cookies, and localfile.
UpdateEntityUpdates an existing entity within a table by replacing it.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
EntityListFired for every entity when ListEntities is called.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TableListFired for every table when ListTables is called.
TransferFired while a document transfers (delivers document).

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

APIVersionThe API version specified in the request.
TransferredDataReturns the entire XML response received from Azure.
URLIf set, the default URL(http://youraccount.blob.core.windows.net/) will be overridden by this value.
AzureTimeoutGets or sets the service timeout for the request in seconds.
DateFormatThe format string to be used for formatting the DateTime values received from the server.
QueryStringFilters the returned results based on provided string properties.
XMLEscapePropertiesWhether entity property names and values are XML escaped.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 2.0.6240.0