Udostępnij za pośrednictwem

Database Columns - List By Database

  • Odwołanie
Usługa:
SQL Database
Wersja interfejsu API:
2021-11-01

Wyświetlanie listy kolumn bazy danych

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/columns?api-version=2021-11-01
Z parametrami opcjonalnymi: 
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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
databaseName
 path True

string

Nazwa bazy danych.
resourceGroupName
 path True

string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName
 path True

string

Nazwa serwera.
subscriptionId
 path True

string

Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version
 query True

string

Wersja interfejsu API do użycia dla żądania.
$skiptoken
 query

string

Nieprzezroczysty token, który identyfikuje punkt początkowy w kolekcji.
column
 query

string[]

orderBy
 query

string[]

schema
 query

string[]

table
 query

string[]

Odpowiedzi

Nazwa Typ Opis
200 OK

DatabaseColumnListResult

Pomyślnie pobrano kolumny bazy danych.
Other Status Codes

Odpowiedzi na błędy: ***

  • 400 UnsupportedColumnOrderByProperty — właściwość order-by "{0}" nie jest obsługiwana. Dozwolone właściwości to: {1}.

  • 400 UnsupportedColumnSortDirection — kierunek sortowania kolumny "{0}" nie jest obsługiwany. Dozwolone wartości to: {1}.

  • 400 UpdateNotAllowedOnPausedDatabase — użytkownik próbował wykonać aktualizację wstrzymanej bazy danych.

  • 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera

  • 404 SourceDatabaseNotFound — źródłowa baza danych nie istnieje.

  • 404 DatabaseDoesNotExist — użytkownik określił nazwę bazy danych, która nie istnieje w tym wystąpieniu serwera.

  • 404 ResourceDoesNotExist — zasób o nazwie "{0}" nie istnieje. Aby kontynuować, określ prawidłową nazwę zasobu.

  • 503 DatabaseUnavailable — operacja nie powiodła się, ponieważ baza danych jest niedostępna.

Przykłady

Filter database columns
List database columns

Filter database columns

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ColumnDataType

Typ danych kolumny.
DatabaseColumn

Zasób kolumny bazy danych.
DatabaseColumnListResult

Lista kolumn bazy danych.
TableTemporalType

Typ czasowy tabeli.

ColumnDataType

Typ danych kolumny.

Nazwa Typ Opis
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

Zasób kolumny bazy danych.

Nazwa Typ Opis
id

string

Identyfikator zasobu.
name

string

Nazwa zasobu.
properties.columnType

ColumnDataType

Typ danych kolumny.
properties.isComputed

boolean

Określa, czy kolumna jest obliczana.
properties.memoryOptimized

boolean

Określa, czy kolumna należy do tabeli zoptymalizowanej pod kątem pamięci.
properties.temporalType

TableTemporalType

Typ czasowy tabeli.
type

string

Typ zasobu.

DatabaseColumnListResult

Lista kolumn bazy danych.

Nazwa Typ Opis
nextLink

string

Łącze, aby pobrać następną stronę wyników.
value

DatabaseColumn[]

Tablica wyników.

TableTemporalType

Typ czasowy tabeli.

Nazwa Typ Opis
HistoryTable

string

NonTemporalTable

string

SystemVersionedTemporalTable

string