Database Columns - List By Table

Служба:

SQL Database

Версия API:

2021-11-01

Вывод списка столбцов базы данных

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns?api-version=2021-11-01

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns?$filter={$filter}&api-version=2021-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
schemaName	path	True	string	Имя схемы.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
tableName	path	True	string	Название таблицы.
api-version	query	True	string	Версия API, используемая для запроса.
$filter	query		string	Выражение фильтра OData, которое фильтрует элементы в коллекции.

Ответы

Имя	Тип	Описание
200 OK	DatabaseColumnListResult	Столбцы базы данных успешно получены.
Other Status Codes		Ответы на ошибки: *** 400 UpdateNotAllowedOnPausedDatabase — пользователь попытался выполнить обновление в приостановленной базе данных. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 SourceDatabaseNotFound — исходная база данных не существует. 404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует на этом экземпляре сервера. 404 ResourceDoesNotExist — ресурс с именем "{0}" не существует. Чтобы продолжить, укажите допустимое имя ресурса. 404 InvalidDatabaseSchema — схема отсутствует в базе данных. 404 InvalidDatabaseTable — таблица отсутствует в базе данных. 404 InvalidDatabaseColumn — столбец отсутствует в таблице. 503 DatabaseUnavailable — операция завершилась ошибкой, так как база данных недоступна.

Примеры

List database columns

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns?api-version=2021-11-01

Java

/**
 * Samples for DatabaseColumns ListByTable.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseColumnListByTable.json
     */
    /**
     * Sample code: List database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseColumns().listByTable("myRG", "serverName",
            "myDatabase", "dbo", "table1", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:

200

{
  "value": [
    {
      "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": "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/table1/columns/col2",
      "name": "col2",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns",
      "properties": {
        "columnType": "bit",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      }
    }
  ]
}

Определения

Имя	Описание
ColumnDataType	Тип данных столбца.
DatabaseColumn	Ресурс столбца базы данных.
DatabaseColumnListResult	Список столбцов базы данных.
TableTemporalType	Темпоральный тип таблицы.

ColumnDataType

Перечисление

Тип данных столбца.

Значение	Описание
bigint
binary
bit
char
date
datetime
datetime2
datetimeoffset
decimal
float
geography
geometry
hierarchyid
image
int
money
nchar
ntext
numeric
nvarchar
real
smalldatetime
smallint
smallmoney
sql_variant
sysname
text
time
timestamp
tinyint
uniqueidentifier
varbinary
varchar
xml

DatabaseColumn

Object

Ресурс столбца базы данных.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.columnType	ColumnDataType	Тип данных столбца.
properties.isComputed	boolean	Вычисляется ли столбец.
properties.memoryOptimized	boolean	Независимо от того, принадлежит ли столбец оптимизированной для памяти таблице.
properties.temporalType	TableTemporalType	Темпоральный тип таблицы.
type	string	Тип ресурса.

DatabaseColumnListResult

Object

Список столбцов базы данных.

Имя	Тип	Описание
nextLink	string	Ссылка на получение следующей страницы результатов.
value	DatabaseColumn[]	Массив результатов.

TableTemporalType

Перечисление

Темпоральный тип таблицы.

Значение	Описание
HistoryTable
NonTemporalTable
SystemVersionedTemporalTable