Database Columns - List By Database

Ссылка

Служба:: SQL Database

Версия API:: 2021-11-01

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

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

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

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=2021-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.
$skiptoken	query		string	Непрозрачный маркер, определяющий начальную точку в коллекции.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Ответы

Имя	Тип	Описание
200 OK	DatabaseColumnListResult	Столбцы базы данных успешно получены.
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 — операция завершилась сбоем, так как база данных недоступна.

Имя

Тип

Описание

200 OK

DatabaseColumnListResult

Столбцы базы данных успешно получены.

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

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=2021-11-01


import java.util.Arrays;

/**
 * Samples for DatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ColumnsListByDatabaseMax.json
     */
    /**
     * Sample code: Filter database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void filterDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", Arrays.asList("dbo"), Arrays.asList("customer", "address"), Arrays.asList("username"),
            Arrays.asList("schema asc", "table", "column desc"), 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": [
    {
      "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

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

HTTP
Java

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


/**
 * Samples for DatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ColumnsListByDatabaseMin.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().listByDatabase("myRG", "serverName",
            "myDatabase", null, null, null, null, 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": [
    {
      "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

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

Имя	Тип	Описание
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

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

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

DatabaseColumnListResult

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

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

TableTemporalType

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

Имя	Тип	Описание
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string

Поделиться через

Database Columns - List By Database

Параметры URI

Ответы

Примеры

Filter database columns

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

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

List database columns

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

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

Определения

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

Дополнительные ресурсы