Database Columns - List By Database

Referenz

Dienst:: SQL Database

API-Version:: 2021-11-01

Auflisten von Datenbankspalten

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

Mit optionalen Parametern:

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.
$skiptoken	query		string	Ein undurchsichtiges Token, das einen Startpunkt in der Auflistung identifiziert.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Antworten

Name	Typ	Beschreibung
200 OK	DatabaseColumnListResult	Datenbankspalten wurden erfolgreich abgerufen.
Other Status Codes		Fehlerantworten: *** 400 UnsupportedColumnOrderByProperty: Die Order-by-Eigenschaft "{0}" wird nicht unterstützt. Zulässige Eigenschaften sind: {1}. 400 Nicht unterstütztColumnSortDirection: Die Spaltensortierrichtung "{0}" wird nicht unterstützt. Zulässige Werte sind: {1}. 400 UpdateNotAllowedOnPausedDatabase: Der Benutzer hat versucht, eine Aktualisierung für eine angehaltene Datenbank durchzuführen. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden 404 SourceDatabaseNotFound: Die Quelldatenbank ist nicht vorhanden. 404 DatabaseDoesNotExist: Der Benutzer hat einen Datenbanknamen angegeben, der auf diesem Server instance nicht vorhanden ist. 404 ResourceDoesNotExist: Ressource mit dem Namen "{0}" ist nicht vorhanden. Geben Sie zum Fortfahren einen gültigen Ressourcennamen an. 503 DatabaseUnavailable: Fehler beim Vorgang, weil die Datenbank nicht verfügbar ist.

Name

Typ

Beschreibung

200 OK

DatabaseColumnListResult

Datenbankspalten wurden erfolgreich abgerufen.

Other Status Codes

Fehlerantworten: ***

400 UnsupportedColumnOrderByProperty: Die Order-by-Eigenschaft "{0}" wird nicht unterstützt. Zulässige Eigenschaften sind: {1}.
400 Nicht unterstütztColumnSortDirection: Die Spaltensortierrichtung "{0}" wird nicht unterstützt. Zulässige Werte sind: {1}.
400 UpdateNotAllowedOnPausedDatabase: Der Benutzer hat versucht, eine Aktualisierung für eine angehaltene Datenbank durchzuführen.
404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden
404 SourceDatabaseNotFound: Die Quelldatenbank ist nicht vorhanden.
404 DatabaseDoesNotExist: Der Benutzer hat einen Datenbanknamen angegeben, der auf diesem Server instance nicht vorhanden ist.
404 ResourceDoesNotExist: Ressource mit dem Namen "{0}" ist nicht vorhanden. Geben Sie zum Fortfahren einen gültigen Ressourcennamen an.
503 DatabaseUnavailable: Fehler beim Vorgang, weil die Datenbank nicht verfügbar ist.

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ColumnDataType	Der Spaltendatentyp.
DatabaseColumn	Eine Datenbankspaltenressource.
DatabaseColumnListResult	Eine Liste der Datenbankspalten.
TableTemporalType	Der temporale Tabellentyp.

ColumnDataType

Der Spaltendatentyp.

Name	Typ	Beschreibung
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

Eine Datenbankspaltenressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.columnType	ColumnDataType	Der Spaltendatentyp.
properties.isComputed	boolean	Gibt an, ob die Spalte berechnet wird.
properties.memoryOptimized	boolean	Gibt an, ob die Spalte zu einer speicheroptimierten Tabelle gehört oder nicht.
properties.temporalType	TableTemporalType	Der temporale Tabellentyp.
type	string	Der Ressourcentyp.

DatabaseColumnListResult

Eine Liste der Datenbankspalten.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Ergebnisseite.
value	DatabaseColumn[]	Array von Ergebnissen.

TableTemporalType

Der temporale Tabellentyp.

Name	Typ	Beschreibung
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string

Freigeben über

Database Columns - List By Database

URI-Parameter

Antworten

Beispiele

Filter database columns

Beispielanforderung

Beispiel für eine Antwort

List database columns

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

Zusätzliche Ressourcen