Connectors Reference

Azure SQL Data Warehouse

Microsoft Azure SQL Data Warehouse is a relational database management system developed by Microsoft. Connect to Azure SQL Data Warehouse to view your data.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetDataSetsMetadata ()

 

TestConnection ()

 

GetProcedures ()

Get stored procedures

ODataStyleGetProcedures (string dataSet)

Get stored procedures

GetProcedure (string procedure)

Get procedure metadata

ODataStyleGetProcedure (string dataSet, string procedure)

Get procedure metadata

GetTable (string table)

Get table metadata

ODataStyleGetTable (string dataset, string table)

Get table metadata

GetDataSets ()

Gets datasets

GetFilteredTables ([advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

GetTables with OData paging and filtering

GetTables ()

Get tables

ODataStyleGetTables (string dataset)

 

GetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [advanced][Optional]string $select)

Get rows

ODataStyleGetItems (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [advanced][Optional]string $select)

Get rows

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

BlobDataSetsMetadata

 

DataSet

 

DataSetsList

 

DataSetsMetadata

 

Item

 

ItemsList

 

Object

 

Procedure

 

ProcedureMetadata

 

Table

 

TableCapabilitiesMetadata

 

TableFilterRestrictionsMetadata

 

TableMetadata

 

TablesList

 

TableSortRestrictionsMetadata

 

TabularDataSetsMetadata

 

 

Actions:

GetDataSetsMetadata

Summary:

Description:

 

Syntax:

AzureSQLDataWarehouse.GetDataSetsMetadata ()

 

Returns:

          Type:DataSetsMetadata

 

TestConnection

Summary:

Description:

 

Syntax:

AzureSQLDataWarehouse.TestConnection ()

 

Returns:

 

GetProcedures

Summary: Get stored procedures

Description: This operation gets stored procedures for a database.

 

Syntax:

AzureSQLDataWarehouse.GetProcedures ()

 

Returns:

          Type:array of (Procedure)

 

ODataStyleGetProcedures

Summary: Get stored procedures

Description: This operation gets stored procedures for a database.

 

Syntax:

AzureSQLDataWarehouse.ODataStyleGetProcedures (string dataSet)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataSet

string

(Dataset name)

 

True

 

Returns:

          Type:array of (Procedure)

 

GetProcedure

Summary: Get procedure metadata

Description: This operation gets metadata for a stored procedure.

 

Syntax:

AzureSQLDataWarehouse.GetProcedure (string procedure)

 

Parameters:

Name

Type

Summary

Required

Related Action

procedure

string

(Procedure name)

Name of stored procedure

True

GetProcedures

 

Returns:

          Type:ProcedureMetadata

 

ODataStyleGetProcedure

Summary: Get procedure metadata

Description: This operation gets metadata for a stored procedure.

 

Syntax:

AzureSQLDataWarehouse.ODataStyleGetProcedure (string dataSet, string procedure)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataSet

string

(Dataset name)

Name of dataset

True

procedure

string

(Procedure name)

Name of stored procedure

True

 

Returns:

          Type:ProcedureMetadata

 

GetTable

Summary: Get table metadata

Description: This operation gets metadata for a table.

 

Syntax:

AzureSQLDataWarehouse.GetTable (string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Table name)

Name of table

True

GetTables

 

Returns:

          Type:TableMetadata

 

ODataStyleGetTable

Summary: Get table metadata

Description: This operation gets metadata for a table.

 

Syntax:

AzureSQLDataWarehouse.ODataStyleGetTable (string dataset, string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset name)

Name of dataset

True

table

string

(Table name)

Name of table

True

 

Returns:

          Type:TableMetadata

 

GetDataSets

Summary: Gets datasets

Description: This operation gets all datasets available to the connection.

 

Syntax:

AzureSQLDataWarehouse.GetDataSets ()

 

Returns:

          Type:DataSetsList

 

GetFilteredTables

Summary: GetTables with OData paging and filtering

Description: GetTables with OData paging and filtering

 

Syntax:

AzureSQLDataWarehouse.GetFilteredTables ([advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all)

False

$skip

integer(int32)

(Skip Count)

Number of entries to skip (default = 0)

False

 

Returns:

          Type:TablesList

 

GetTables

Summary: Get tables

Description: This operation gets tables from a database.

 

Syntax:

AzureSQLDataWarehouse.GetTables ()

 

Returns:

          Type:TablesList

 

ODataStyleGetTables

Summary:

Description:

 

Syntax:

AzureSQLDataWarehouse.ODataStyleGetTables (string dataset)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

 

 

True

 

Returns:

          Type:TablesList

 

GetItems

Summary: Get rows

Description: This operation gets rows from a table.

 

Syntax:

AzureSQLDataWarehouse.GetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [advanced][Optional]string $select)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Table name)

Name of SQL table

True

GetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries

False

$skip

integer(int32)

(Skip Count)

Number of entries to skip (default = 0)

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all)

False

$select

string

(Select Query)

Specific fields to retrieve from entries (default = all)

False

 

Returns:

          Type:ItemsList

 

ODataStyleGetItems

Summary: Get rows

Description: This operation gets rows from a table.

 

Syntax:

AzureSQLDataWarehouse.ODataStyleGetItems (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [advanced][Optional]string $select)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset name)

Name of dataset

True

table

string

(Table name)

Name of table

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries

False

$skip

integer(int32)

(Skip Count)

Number of entries to skip (default = 0)

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all)

False

$select

string

(Select Query)

Specific fields to retrieve from entries (default = all)

False

 

Returns:

          Type:ItemsList

 


 

BlobDataSetsMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

source

string

 

 

displayName

string

 

 

urlEncoding

string

 

 


 

DataSet

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

 

DisplayName

string

 

 


 

DataSetsList

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (DataSet)

 

 


 

DataSetsMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

tabular

TabularDataSetsMetadata

 

 

blob

BlobDataSetsMetadata

 

 


 

Item

Summary:

Description:

 

          Properties:

Name

Type

Summary

ItemInternalId

string

 

 


 

ItemsList

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Item)

 

 


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Procedure

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

 

DisplayName

string

 

 


 

ProcedureMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

title

string

 

 

schema

Object

 

 


 

Table

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

 

DisplayName

string

 

 


 

TableCapabilitiesMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

sortRestrictions

TableSortRestrictionsMetadata

 

 

filterRestrictions

TableFilterRestrictionsMetadata

 

 

isOnlyServerPagable

boolean

 

 

filterFunctionSupport

array of (string)

 

 


 

TableFilterRestrictionsMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

filterable

boolean

 

 

nonFilterableProperties

array of (string)

 

 

requiredProperties

array of (string)

 

 


 

TableMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

title

string

 

 

x-ms-permission

string

 

 

x-ms-capabilities

TableCapabilitiesMetadata

 

 

schema

Object

 

 

referencedEntities

Object

 

 


 

TablesList

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Table)

 

 


 

TableSortRestrictionsMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

sortable

boolean

 

 

unsortableProperties

array of (string)

 

 

ascendingOnlyProperties

array of (string)

 

 


 

TabularDataSetsMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

source

string

 

 

displayName

string

 

 

urlEncoding

string

 

 

tableDisplayName

string

 

 

tablePluralName

string