SDS Command Line Tool

[This document supports a preliminary release of a software product that may be changed substantially prior to final commercial release. This document is provided for informational purposes only.]

SDS tool (st.exe) is a general purpose data manipulation tool for use with Microsoft® SQL Data Services (SDS). The command line tool allows you to explore SDS without having to write code. It allows you to create, update, delete entities (authorities, containers, entities), and specify queries. You can upload blobs and perform backup and restore operations. You may find this tool useful in debugging your application with SDS. Both SOAP and REST interfaces can be tested.

The general syntax is:

st <command> [options] 

The following table lists the commands supported:

Command Description

st create

Creates an authority, a container or an entity.

st replace

Replaces (update) an existing entity.

st delete

Deletes an authority, container or entity

st get

Fetches an authority, a container or an entity.

st getall

Fetches all containers or entities.

st query

Queries an authority or container

st backup

Backup all containers and entities within an authority.

st restore

Restores authority or single container.

st options

Persists options to app.config file.

st loadbatch

Loads (inserts or updates) containers or entities using multiple sessions. Existing items are skipped. If /overwrite is specified, the existing items are updated.

The following table lists supported options. Note that all these options are not available with each of the commands. For options supported on a command, see documentation for the specific command.

option Required? Description

/host:<host>

No

Host name of SDS service. The default value is data.database.window.net

/user:<username>

Yes

Name of user. Note that you will be prompted for the password where you can provide your password or certificate private key).

/infocard

No

Prompts user for Windows CardSpace information card.

/cert:<filename>

No

Name of X.509 certificate file (must contain private key).

/soap

No

Use SOAP to access SDS.

/rest

No

Use REST to access SDS. This is the default.

/verbose

No

Log additional information.

/parallel:<number>

No

In a batch request, it is the number of operations done in parallel.

/overwrite

No

Overwrite operation target, if exists. Disabled by default.

/help or /?

No

Show usage information.

/accept:"<accept-header>"

No

Accept header that can be specified in a REST GET request. By default, no accept header is used. Useful when retrieving blobs.

/console

No

On blob GET, specifies that the blob be written to console. By default, the retrieved blob is stored in a file.

/timeout

No

Timeout in milliseconds. Default value is 30,000 milliseconds. For uploading or downloading large blobs you may need to increase the timeout value.

See Also

Concepts

st create
st replace
st delete
st get
st getall
st query
st backup
st restore
st options