sql_pool_table_columns

Creates, updates, deletes, gets or lists a sql_pool_table_columns resource.

Overview

Name	sql_pool_table_columns
Type	Resource
Id	azure.synapse.sql_pool_table_columns

Fields

The following fields are returned by SELECT queries:

list_by_table_name

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
columnType	string	The column data type. Known values are: "image", "text", "uniqueidentifier", "date", "time", "datetime2", "datetimeoffset", "tinyint", "smallint", "int", "smalldatetime", "real", "money", "datetime", "float", "sql_variant", "ntext", "bit", "decimal", "numeric", "smallmoney", "bigint", "hierarchyid", "geometry", "geography", "varbinary", "varchar", "binary", "char", "timestamp", "nvarchar", "nchar", "xml", and "sysname".
isComputed	boolean	Indicates whether column value is computed or not.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_table_name	select	resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, subscription_id	$filter	Gets columns in a given table in a SQL pool. Gets columns in a given table in a SQL pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
schema_name	string	The name of the schema. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
table_name	string	The name of the table. Required.
workspace_name	string	The name of the workspace. Required.
$filter	string	An OData filter expression that filters elements in the collection. Default value is None.

SELECT examples

list_by_table_name

Gets columns in a given table in a SQL pool. Gets columns in a given table in a SQL pool.

SELECT
id,
name,
columnType,
isComputed,
type
FROM azure.synapse.sql_pool_table_columns
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND table_name = '{{ table_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;