TableServiceClient Klasa

  • Odwołanie

Klient do interakcji z usługą Table Service na poziomie konta.

Ten klient udostępnia operacje pobierania i konfigurowania właściwości konta, a także listy, tworzenia i usuwania tabel w ramach konta. W przypadku operacji związanych z określoną tabelą można pobrać klienta dla tej jednostki przy użyciu get_table_client funkcji .

Utwórz obiekt TablesBaseClient na podstawie poświadczeń.

Dziedziczenie
azure.data.tables._base_client.TablesBaseClient
TableServiceClient

Konstruktor

TableServiceClient(endpoint: str, *, credential: AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs)

Parametry

endpoint
str
Wymagane

Adres URL punktu końcowego usługi tabeli. Wszystkie inne jednostki uwzględnione w ścieżce adresu URL (np. tabeli) zostaną odrzucone. Ten adres URL można opcjonalnie uwierzytelnić przy użyciu tokenu SAS.

credential
AzureNamedKeyCredential lub AzureSasCredential lub TokenCredential lub None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS. Wartość może być jedną z wartości AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) lub implementacją TokenCredential na podstawie tożsamości platformy Azure.

api_version
str

Wersja interfejsu API usługi Storage do użycia dla żądań. Wartość domyślna to "2019-02-02". Ustawienie starszej wersji może spowodować zmniejszenie zgodności funkcji.

endpoint
str
Wymagane

Adres URL konta usługi Azure Tables.

credential
AzureNamedKeyCredential lub AzureSasCredential lub TokenCredential lub None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS. Wartość może być jedną z wartości AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) lub implementacją TokenCredential na podstawie tożsamości platformy Azure.

api_version
str lub None

Określa wersję operacji do użycia dla tego żądania. Wartość domyślna to "2019-02-02".

Przykłady

Uwierzytelnianie obiektu TableServiceClient z klucza dostępu współdzielonego


   from azure.data.tables import TableServiceClient
   from azure.core.credentials import AzureNamedKeyCredential, AzureSasCredential

   # Create a SAS token to use for authentication of a client
   from azure.data.tables import generate_account_sas, ResourceTypes, AccountSasPermissions

   print("Account name: {}".format(self.account_name))
   credential = AzureNamedKeyCredential(self.account_name, self.access_key)  # type: ignore[arg-type]
   sas_token = generate_account_sas(
       credential,
       resource_types=ResourceTypes(service=True),
       permission=AccountSasPermissions(read=True),
       expiry=datetime.utcnow() + timedelta(hours=1),
   )

   with TableServiceClient(
       endpoint=self.endpoint, credential=AzureSasCredential(sas_token)
   ) as token_auth_table_service:
       properties = token_auth_table_service.get_service_properties()
       print("Shared Access Signature: {}".format(properties))

Uwierzytelnianie obiektu TableServiceClient przy użyciu klucza współużytkowanego konta


   from azure.data.tables import TableServiceClient
   from azure.core.credentials import AzureNamedKeyCredential

   credential = AzureNamedKeyCredential(self.account_name, self.access_key)  # type: ignore[arg-type]
   with TableServiceClient(endpoint=self.endpoint, credential=credential) as table_service:
       properties = table_service.get_service_properties()
       print("Shared Key: {}".format(properties))

Zmienne

account_name
str

Nazwa konta Tabele.

url
str

Pełny adres URL konta Tabele.

Metody

close

Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu.
create_table

Tworzy nową tabelę w ramach bieżącego konta.
create_table_if_not_exists

Tworzy nową tabelę, jeśli nie istnieje obecnie. Jeśli tabela obecnie istnieje, zwracana jest bieżąca tabela.
delete_table

Usuwa tabelę w ramach bieżącego konta. Jeśli dana tabela nie zostanie znaleziona, nie zostanie zgłoszony żaden błąd.
from_connection_string

Utwórz obiekt TableServiceClient na podstawie parametrów połączenia.
get_service_properties

Pobiera właściwości usługi Table service konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).
get_service_stats

Pobiera statystyki związane z replikacją dla usługi Table Service. Jest on dostępny tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.
get_table_client

Pobierz klienta do interakcji z określoną tabelą.

Tabela nie musi jeszcze istnieć.
list_tables

Wykonuje zapytania w tabelach w ramach danego konta.
query_tables

Wykonuje zapytania w tabelach w ramach danego konta.
set_service_properties

Ustawia właściwości punktu końcowego usługi Tabel konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).

close

Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu.

close() -> None

create_table

Tworzy nową tabelę w ramach bieżącego konta.

create_table(table_name: str, **kwargs) -> TableClient

Parametry

table_name
str
Wymagane

Nazwa tabeli.

Zwraca

TableClient

Typ zwracany

TableClient

Wyjątki

ResourceExistsError

Przykłady

Tworzenie tabeli na podstawie obiektu TableServiceClient


   with TableServiceClient.from_connection_string(self.connection_string) as table_service_client:
       try:
           table_client = table_service_client.create_table(table_name=self.table_name)
           print("Created table {}!".format(table_client.table_name))
       except ResourceExistsError:
           print("Table already exists")

create_table_if_not_exists

Tworzy nową tabelę, jeśli nie istnieje obecnie. Jeśli tabela obecnie istnieje, zwracana jest bieżąca tabela.

create_table_if_not_exists(table_name: str, **kwargs) -> TableClient

Parametry

table_name
str
Wymagane

Nazwa tabeli.

Zwraca

TableClient

Typ zwracany

TableClient

Wyjątki

HttpResponseError

Przykłady

Tworzenie tabeli, jeśli nie istnieje, z obiektu TableServiceClient


   with TableServiceClient.from_connection_string(self.connection_string) as table_service_client:
       table_client = table_service_client.create_table_if_not_exists(table_name=self.table_name)
       print("Table name: {}".format(table_client.table_name))

delete_table

Usuwa tabelę w ramach bieżącego konta. Jeśli dana tabela nie zostanie znaleziona, nie zostanie zgłoszony żaden błąd.

delete_table(table_name: str, **kwargs) -> None

Parametry

table_name
str
Wymagane

Nazwa tabeli.

Zwraca

Brak

Wyjątki

HttpResponseError

Przykłady

Usuwanie tabeli z obiektu TableServiceClient


   with TableServiceClient.from_connection_string(self.connection_string) as table_service_client:
       table_service_client.delete_table(table_name=self.table_name)
       print("Deleted table {}!".format(self.table_name))

from_connection_string

Utwórz obiekt TableServiceClient na podstawie parametrów połączenia.

from_connection_string(conn_str: str, **kwargs) -> TableServiceClient

Parametry

conn_str
str
Wymagane

Parametry połączenia z kontem usługi Azure Storage lub Cosmos.

Zwraca

Klient usługi table service.

Typ zwracany

TableServiceClient

Przykłady

Uwierzytelnianie obiektu TableServiceClient z connection_string


   from azure.data.tables import TableServiceClient

   with TableServiceClient.from_connection_string(conn_str=self.connection_string) as table_service:
       properties = table_service.get_service_properties()
       print("Connection String: {}".format(properties))

get_service_properties

Pobiera właściwości usługi Table service konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).

get_service_properties(**kwargs) -> Dict[str, object]

Zwraca

Słownik właściwości usługi

Typ zwracany

dict[str, object]

Wyjątki

HttpResponseError

get_service_stats

Pobiera statystyki związane z replikacją dla usługi Table Service. Jest on dostępny tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.

get_service_stats(**kwargs) -> Dict[str, object]

Zwraca

Słownik statystyk usługi

Typ zwracany

dict[str, object]

Wyjątki

azure.core.exceptions.HttpResponseError:

get_table_client

Pobierz klienta do interakcji z określoną tabelą.

Tabela nie musi jeszcze istnieć.

get_table_client(table_name: str, **kwargs) -> TableClient

Parametry

table_name
str
Wymagane

Nazwa tabeli

Zwraca

Obiekt TableClient.

Typ zwracany

TableClient

list_tables

Wykonuje zapytania w tabelach w ramach danego konta.

list_tables(**kwargs) -> ItemPaged[TableItem]

Parametry

results_per_page
int

Liczba tabel na stronę w zwracanym elemencie ItemPaged

Zwraca

Iterator TableItem

Typ zwracany

ItemPaged[TableItem]

Wyjątki

HttpResponseError

Przykłady

Wyświetlanie listy wszystkich tabel na koncie magazynu


   # List all the tables in the service
   list_tables = table_service.list_tables()
   print("Listing tables:")
   for table in list_tables:
       print("\t{}".format(table.name))

query_tables

Wykonuje zapytania w tabelach w ramach danego konta.

query_tables(query_filter: str, **kwargs) -> ItemPaged[TableItem]

Parametry

query_filter
str
Wymagane

Określ filtr, aby zwrócić określone tabele.

results_per_page
int

Liczba tabel na stronę w zwracaniu elementu ItemPaged

parameters
dict[str, Any]

Słownik do formatowania zapytania z dodatkowymi parametrami zdefiniowanymi przez użytkownika

Zwraca

Iterator TableItem

Typ zwracany

ItemPaged[TableItem]

Wyjątki

HttpResponseError

Przykłady

Wykonywanie zapytań dotyczących tabel na koncie magazynu


   table_name = "mytable1"
   name_filter = "TableName eq '{}'".format(table_name)
   queried_tables = table_service.query_tables(name_filter)

   print("Queried_tables")
   for table in queried_tables:
       print("\t{}".format(table.name))

set_service_properties

Ustawia właściwości punktu końcowego usługi Tabel konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).

set_service_properties(**kwargs) -> None

Parametry

analytics_logging
TableAnalyticsLogging

Właściwości analizy

hour_metrics
TableMetrics

Metryki poziomu godziny

minute_metrics
TableMetrics

Metryki na poziomie minuty

cors
list[TableCorsRule]

Reguły współużytkowania zasobów między źródłami

Zwraca

Brak

Wyjątki

HttpResponseError

Atrybuty

api_version

Wersja interfejsu API usługi Storage używana na potrzeby żądań.

Zwraca

Wersja interfejsu API usługi Storage.

url

Pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany.

Może to być podstawowy punkt końcowy lub pomocniczy punkt końcowy w zależności od bieżącego <xref:azure.data.tables.location_mode>.

Zwraca

Pełny adres URL punktu końcowego, w tym token SAS, jeśli jest używany.

Typ zwracany

str