Connectors Reference
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: Production |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
|
|
|
|
|
|
ExecuteProcedure (string procedure, ExecuteProcedureParameterParameters parameters) |
Execute stored procedure |
|
Get stored procedures |
|
|
Get stored procedures |
|
|
Get procedure metadata |
|
|
Get procedure metadata |
|
|
Get table metadata |
|
|
Get table metadata |
|
|
GetPassThroughNativeQueryMetadata ([Optional]PassThroughNativeQueryBody query) |
Get pass-through native query metadata |
|
Gets datasets |
|
|
GetTables with OData paging and filtering |
|
|
Get tables |
|
|
|
|
|
ExecutePassThroughNativeQuery (PassThroughNativeQueryBody query) |
Execute a SQL query |
|
Get rows |
|
|
Get rows |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary:
Description:
Syntax:
AzureSQLDataWarehouse.GetDataSetsMetadata ()
Returns:
Type:DataSetsMetadata
Summary:
Description:
Syntax:
AzureSQLDataWarehouse.TestConnection ()
Returns:
Summary: Execute stored procedure
Description: This operation runs a stored procedure.
Syntax:
AzureSQLDataWarehouse.ExecuteProcedure (string procedure, ExecuteProcedureParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
procedure |
string (Procedure name) |
Name of stored procedure |
True |
|
|
parameters |
ExecuteProcedureParameterParameters
|
|
True |
Returns:
Summary: Get stored procedures
Description: This operation gets stored procedures for a database.
Syntax:
AzureSQLDataWarehouse.GetProcedures ()
Returns:
Type:array of (Procedure)
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)
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 |
Returns:
Type:ProcedureMetadata
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
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 |
Returns:
Type:TableMetadata
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
Summary: Get pass-through native query metadata
Description: Retrieves metadata for a pass-through native query
Syntax:
AzureSQLDataWarehouse.GetPassThroughNativeQueryMetadata ([Optional]PassThroughNativeQueryBody query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
query |
|
Input body to execute Pass-through Native Query (PNQ) |
False |
Returns:
Type:PassThroughNativeQueryMetadata
Description: Represents the metadata for a pass-through native query
Summary: Gets datasets
Description: This operation gets all datasets available to the connection.
Syntax:
AzureSQLDataWarehouse.GetDataSets ()
Returns:
Type:DataSetsList
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
Summary: Get tables
Description: This operation gets tables from a database.
Syntax:
AzureSQLDataWarehouse.GetTables ()
Returns:
Type:TablesList
Summary:
Description:
Syntax:
AzureSQLDataWarehouse.ODataStyleGetTables (string dataset)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dataset |
string
|
|
True |
Returns:
Type:TablesList
Summary: Execute a SQL query
Description: Execute a SQL query
Syntax:
AzureSQLDataWarehouse.ExecutePassThroughNativeQuery (PassThroughNativeQueryBody query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
query |
|
Input body to execute Pass-through Native Query (PNQ) |
True |
Returns:
Type:ExecutePassThroughNativeQueryResponse
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 |
|
|
$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
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
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
source |
string
|
|
|
displayName |
string
|
|
|
urlEncoding |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
DisplayName |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (DataSet)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tabular |
|
|
|
blob |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ItemInternalId |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Item)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Input body to execute Pass-through Native Query (PNQ)
Properties:
|
Name |
Type |
Summary |
|
query |
string
|
Query Text |
|
formalParameters |
|
Formal Parameters |
|
actualParameters |
|
Actual Parameters |
Summary:
Description: Formal Parameters
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Actual Parameters
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Represents the metadata for a pass-through native query
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Query name |
|
title |
string
|
Query title |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
DisplayName |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
title |
string
|
|
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
DisplayName |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
sortRestrictions |
|
|
|
filterRestrictions |
TableFilterRestrictionsMetadata
|
|
|
isOnlyServerPagable |
boolean
|
|
|
filterFunctionSupport |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
filterable |
boolean
|
|
|
nonFilterableProperties |
array of (string)
|
|
|
requiredProperties |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
title |
string
|
|
|
x-ms-permission |
string
|
|
|
x-ms-capabilities |
|
|
|
schema |
|
|
|
referencedEntities |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Table)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
sortable |
boolean
|
|
|
unsortableProperties |
array of (string)
|
|
|
ascendingOnlyProperties |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
source |
string
|
|
|
displayName |
string
|
|
|
urlEncoding |
string
|
|
|
tableDisplayName |
string
|
|
|
tablePluralName |
string
|
|