你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Database Columns - List By Database

列出数据库列

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/columns?api-version=2022-02-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/columns?schema={schema}&table={table}&column={column}&orderBy={orderBy}&$skiptoken={$skiptoken}&api-version=2022-02-01-preview

URI 参数

Name In Required Type Description
databaseName
path True
  • string

数据库的名称。

resourceGroupName
path True
  • string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True
  • string

服务器的名称。

subscriptionId
path True
  • string

用于标识 Azure 订阅的订阅 ID。

api-version
query True
  • string

要用于请求的 API 版本。

$skiptoken
query
  • string

标识集合中起点的不透明标记。

column
query
  • array
orderBy
query
  • array
schema
query
  • array
table
query
  • array

响应

Name Type Description
200 OK

已成功检索数据库列。

Other Status Codes

错误响应: ***

  • 400 UnsupportedColumnOrderByProperty - 不支持 order-by 属性“{0}” 。 允许的属性为: {1}。

  • 400 UnsupportedColumnSortDirection - 不支持列排序方向“{0}” 。 允许值包括:{1}。

  • 400 UpdateNotAllowedOnPausedDatabase - 用户尝试对暂停的数据库执行更新。

  • 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

  • 404 SourceDatabaseNotFound - 源数据库不存在。

  • 404 DatabaseDoesNotExist - 用户已指定在此服务器实例上不存在的数据库名称。

  • 404 ResourceDoesNotExist - 名称为“”{0}的资源不存在。 若要继续,请指定有效的资源名称。

  • 503 DatabaseUnavailable - 操作失败,因为数据库不可用。

示例

Filter database columns
List database columns

Filter database columns

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/columns?schema=dbo&table=customer&table=address&column=username&orderBy=schema asc&orderBy=table&orderBy=column desc&api-version=2022-02-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "columnType": "nvarchar",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/customer/columns/username",
      "name": "username",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns"
    }
  ]
}

List database columns

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/columns?api-version=2022-02-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "columnType": "int",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col1",
      "name": "col1",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns"
    },
    {
      "properties": {
        "columnType": "bit",
        "temporalType": "SystemVersionedTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col2",
      "name": "col2",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns"
    }
  ]
}

定义

ColumnDataType

列数据类型。

DatabaseColumn

数据库列资源。

DatabaseColumnListResult

数据库列的列表。

TableTemporalType

表临时类型。

ColumnDataType

列数据类型。

Name Type Description
bigint
  • string
binary
  • string
bit
  • string
char
  • string
date
  • string
datetime
  • string
datetime2
  • string
datetimeoffset
  • string
decimal
  • string
float
  • string
geography
  • string
geometry
  • string
hierarchyid
  • string
image
  • string
int
  • string
money
  • string
nchar
  • string
ntext
  • string
numeric
  • string
nvarchar
  • string
real
  • string
smalldatetime
  • string
smallint
  • string
smallmoney
  • string
sql_variant
  • string
sysname
  • string
text
  • string
time
  • string
timestamp
  • string
tinyint
  • string
uniqueidentifier
  • string
varbinary
  • string
varchar
  • string
xml
  • string

DatabaseColumn

数据库列资源。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.columnType

列数据类型。

properties.isComputed
  • boolean

是否计算列。

properties.memoryOptimized
  • boolean

列是否属于内存优化表。

properties.temporalType

表临时类型。

type
  • string

资源类型。

DatabaseColumnListResult

数据库列的列表。

Name Type Description
nextLink
  • string

用于检索下一页结果的链接。

value

结果数组。

TableTemporalType

表临时类型。

Name Type Description
HistoryTable
  • string
NonTemporalTable
  • string
SystemVersionedTemporalTable
  • string