Azure Storage - Download entities

Declaration

<AMAZURESTORAGE ACTIVITY="download_entities" TABLE="text" 
FILE="text" OVERWRITE="yes/no" 
INCLUDECOLUMNTYPES="yes/no" PROTOCOL="text (options)" 
ACCOUNTNAME="text" 
ACCESSKEY="text (encrypted)" BLOBENDPOINT="text" 
QUEUEENDPOINT="text" TABLEENDPOINT="text" 
TIMEOUT="number" PROXYTYPE="text (options)" 
PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" 
PROXYPASSWORD="text (encrypted)" />

Description: Download one or more entities to a comma-separated values (.csv) file or comma-delimited text (.txt) file.

Practical Usage

Used to move large amounts of cloud data to a local system.

Connection Parameters

Property

Type

Required

Default

Markup

Description

         

Connection

 

 

 

 

Indicates where user credentials and preferences should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:

  • Host (default) - Specifies that user credentials and/or advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.

  • Session - Specifies that user credentials and/or advanced preferences are obtained from a pre-configured session created in a prior step with the use of the Azure Storage - Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.

Session

Text

Yes if connection is session-based

AzureStorageSession1

SESSION="MyAzureSession"

The name of an existing session to associate this activity with. This parameter is active only if the Connection parameter is set to Session. The default session name is 'AzureStorageSession1'.

Account name

Text

Yes if connection is host-based

(Empty)

ACCOUNTNAME="myaccount"

The globally unique name of the Windows Azure storage account. This parameter is active only if the Connection parameter is set to Host.

Access key

Text

Yes if connection is host-based

(Empty)

ACCESSKEY="[AccessKey]"

The primary or secondary access key (each composed of 88 ASCII characters) used to authorize access to Azure Storage. This parameter is active only if the Connection parameter is set to Host.

Protocol

Text (options)

No

HTTPS

  1. PROTOCOL="HTTPS"

  2. PROTOCOL="HTTP"

The type of protocol used to access Azure Storage. The available options are:

  • HTTPS (default) - Hypertext Transfer Protocol Secure

  • HTTP - Hypertext Transfer Protocol

Timeout (seconds)

Number

No

90

TIMEOUT="180"

The timeout interval (in seconds) for requests made to the storage service. If the timeout elapses before a server response is returned, the operation times out and the service returns an error. The default timeout value is 90 seconds.

Blob endpoint URI

Text

No

(Empty)

BLOBENDPOINT="http://

accnt

.blob.core.windows.net"

The endpoint for the Blob service, as configured for the Azure Storage account. The default Blob service endpoint is'[http/https]://accountname.blob.core.windows.net',where 'accountname' is the name of the Azure Storage account.

Queue endpoint URI

Text

No

(Empty)

QUEUEENDPOINT="http://

accnt

.queue.core.windows.net"

The endpoint for the Queue service, as configured for the Azure storage account. The default Queue service endpoint is

'[http/https]://accountname.queue.core.windows.net'

, where '

accountname'

is the name of the Azure Storage account.

Table endpoint URI

Text

No

(Empty)

TABLEENDPOINT="http://

accnt

.table.core.windows.net"

The endpoint for the Table service, as configured for the Azure storage account. The default Table service endpoint is '

Property

Table name

Text

Yes

(Empty)

TABLE="mytable"

The unique name of the table that contains the entities to download.

File

Text

Yes

(Empty)

FILE="c\temp\data.csv

The path and filename of the destination .csv file. In visual mode, click the folder icon to open a Save As dialog allowing navigation to the output folder/file or simply enter the path and filename in the text box.

Overwrite

Yes/No

No

Yes

OVERWRITE="yes"

If set to YES, matching files found in the destination will be overwritten. If set to NO, matching files will not be overwritten, however, a runtime error is thrown as a result. Set to NO by default

Use column(s) as first row

Yes/No

No

Yes

USECOLUMNHEADER="no"

If set to YES, the first row of downloaded data will be listed as a header row of column names in the .csv file (e.g., PartitionKey, RowKey, Timestamp, CustId,  StartDate, IsActive). Set to YES by default.

Include column types

Yes/No

No

No

INCLUDECOLUMNTYPES="yes"

If set to YES, the header row of column names will also include column type information. (e.g., CustId:int, StartDate:datetime, IsActive:bool). Set to NO by default.

Include null values

Yes/No

No

No

INCLUDENULLVALUES="no"

If set to YES, specifies that null values will be included in the .csv file and marked as "null". These values area translated back to null property values if the file is subsequently uploaded back into table storage. Set to YES by default.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Download entities from table "CustData" and store it into file "c:\temp\CustomerData.csv". Azure account name is "netauto".

<AMAZURESTORAGE ACTIVITY="download_entities" TABLE="CustData" 
FILE="c:\temp\CustomerData.csv" OVERWRITE="yes" 
INCLUDECOLUMNTYPES="yes" ACCOUNTNAME="netauto" 
ACCESSKEY="AM2jZq/3eKmed6Nmszdg6YY3A==aME" />