Database Columns - List By Database

Référence

Service:: SQL Database

API Version:: 2021-11-01

Répertorier les colonnes de base de données

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$skiptoken	query		string	Jeton opaque qui identifie un point de départ dans la collection.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Réponses

Nom	Type	Description
200 OK	DatabaseColumnListResult	Colonnes de base de données récupérées avec succès.
Other Status Codes		Réponses d’erreur : *** 400 UnsupportedColumnOrderByProperty : la propriété order-by '{0}' n’est pas prise en charge. Les propriétés autorisées sont les suivantes : {1}. 400 UnsupportedColumnSortDirection : le sens de tri de colonne '{0}' n’est pas pris en charge. Valeurs autorisées : {1}. 400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données en pause. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 SourceDatabaseNotFound : la base de données source n’existe pas. 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance. 404 ResourceDoesNotExist : la ressource portant le nom «{0} » n’existe pas. Pour continuer, spécifiez un nom de ressource valide. 503 DatabaseUnavailable : l’opération a échoué, car la base de données n’est pas disponible.

Nom

Type

Description

200 OK

DatabaseColumnListResult

Colonnes de base de données récupérées avec succès.

Other Status Codes

Réponses d’erreur : ***

400 UnsupportedColumnOrderByProperty : la propriété order-by '{0}' n’est pas prise en charge. Les propriétés autorisées sont les suivantes : {1}.
400 UnsupportedColumnSortDirection : le sens de tri de colonne '{0}' n’est pas pris en charge. Valeurs autorisées : {1}.
400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données en pause.
404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 SourceDatabaseNotFound : la base de données source n’existe pas.
404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance.
404 ResourceDoesNotExist : la ressource portant le nom «{0} » n’existe pas. Pour continuer, spécifiez un nom de ressource valide.
503 DatabaseUnavailable : l’opération a échoué, car la base de données n’est pas disponible.

Exemples

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 com.azure.core.util.Context;
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, 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

Sample Response

Status code:: 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

Sample Request

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


import com.azure.core.util.Context;

/** 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, 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

Sample Response

Status code:: 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"
    }
  ]
}

Définitions

Nom	Description
ColumnDataType	Type de données de colonne.
DatabaseColumn	Ressource de colonne de base de données.
DatabaseColumnListResult	Liste des colonnes de base de données.
TableTemporalType	Type temporel de table.

ColumnDataType

Type de données de colonne.

Nom	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

Ressource de colonne de base de données.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.columnType	ColumnDataType	Type de données de colonne.
properties.isComputed	boolean	Indique si la colonne est calculée ou non.
properties.memoryOptimized	boolean	Indique si la colonne appartient ou non à une table à mémoire optimisée.
properties.temporalType	TableTemporalType	Type temporel de table.
type	string	Type de ressource.

DatabaseColumnListResult

Liste des colonnes de base de données.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	DatabaseColumn[]	Tableau de résultats.

TableTemporalType

Type temporel de table.

Nom	Type	Description
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string

Share via

Database Columns - List By Database

Paramètres URI

Réponses

Exemples

Filter database columns

Sample Request

Sample Response

List database columns

Sample Request

Sample Response

Définitions

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

Ressources supplémentaires