Database Columns - List By Database

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Listar colunas de base de dados

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
databaseName	path	True	string	O nome da base de dados.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.
$skiptoken	query		string	Um token opaco que identifica um ponto de partida na coleção.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Respostas

Name	Tipo	Description
200 OK	DatabaseColumnListResult	Colunas de base de dados obtidas com êxito.
Other Status Codes		Respostas de Erro: *** 400 UnsupportedColumnOrderByProperty – a propriedade order-by "{0}" não é suportada. As propriedades permitidas são: {1}. 400 UnsupportedColumnSortDirection – a direção de ordenação da coluna "{0}" não é suportada. Os valores permitidos são: {1}. 400 UpdateNotAllowedOnPausedDatabase – o utilizador tentou efetuar uma atualização numa base de dados em pausa. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 SourceDatabaseNotFound – a base de dados de origem não existe. 404 DatabaseDoesNotExist – o utilizador especificou um nome de base de dados que não existe nesta instância do servidor. 404 ResourceDoesNotExist – o recurso com o nome "{0}" não existe. Para continuar, especifique um nome de recurso válido. 503 DatabaseUnavailable - A operação falhou porque a base de dados não está disponível.

Name

Tipo

Description

200 OK

DatabaseColumnListResult

Colunas de base de dados obtidas com êxito.

Other Status Codes

Respostas de Erro: ***

400 UnsupportedColumnOrderByProperty – a propriedade order-by "{0}" não é suportada. As propriedades permitidas são: {1}.
400 UnsupportedColumnSortDirection – a direção de ordenação da coluna "{0}" não é suportada. Os valores permitidos são: {1}.
400 UpdateNotAllowedOnPausedDatabase – o utilizador tentou efetuar uma atualização numa base de dados em pausa.
404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado
404 SourceDatabaseNotFound – a base de dados de origem não existe.
404 DatabaseDoesNotExist – o utilizador especificou um nome de base de dados que não existe nesta instância do servidor.
404 ResourceDoesNotExist – o recurso com o nome "{0}" não existe. Para continuar, especifique um nome de recurso válido.
503 DatabaseUnavailable - A operação falhou porque a base de dados não está disponível.

Exemplos

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

Resposta da amostra

Código de estado:: 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

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
    }
  ]
}

Definições

Name	Description
ColumnDataType	O tipo de dados da coluna.
DatabaseColumn	Um recurso de coluna de base de dados.
DatabaseColumnListResult	Uma lista de colunas de base de dados.
TableTemporalType	O tipo temporal da tabela.

ColumnDataType

O tipo de dados da coluna.

Name	Tipo	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

Um recurso de coluna de base de dados.

Name	Tipo	Description
id	string	ID do Recurso.
name	string	Nome do recurso.
properties.columnType	ColumnDataType	O tipo de dados da coluna.
properties.isComputed	boolean	Se a coluna é calculada ou não.
properties.memoryOptimized	boolean	Se a coluna pertence ou não a uma tabela otimizada para memória.
properties.temporalType	TableTemporalType	O tipo temporal da tabela.
type	string	Tipo de recurso.

DatabaseColumnListResult

Uma lista de colunas de base de dados.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	DatabaseColumn[]	Matriz de resultados.

TableTemporalType

O tipo temporal da tabela.

Name	Tipo	Description
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string

Partilhar via

Database Columns - List By Database

Parâmetros do URI

Respostas

Exemplos

Filter database columns

Pedido de amostra

Resposta da amostra

List database columns

Pedido de amostra

Resposta da amostra

Definições

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

Recursos adicionais