TableServiceClient Třída

Reference

Klient pro interakci se službou Table Service na úrovni účtu.

Tento klient poskytuje operace pro načtení a konfiguraci vlastností účtu a také výpis, vytvoření a odstranění tabulek v rámci účtu. U operací týkajících se konkrétní tabulky lze klienta pro tuto entitu get_table_client načíst pomocí funkce .

Vytvořte TablesBaseClient z přihlašovacích údajů.

Dědičnost: azure.data.tables._base_client.TablesBaseClient

TableServiceClient

Konstruktor

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

Parametry

endpoint: str

Vyžadováno

Adresa URL koncového bodu služby table. Všechny ostatní entity zahrnuté v cestě URL (např. tabulka) budou zahozeny. Tuto adresu URL je možné volitelně ověřit pomocí tokenu SAS.

credential: AzureNamedKeyCredential nebo AzureSasCredential nebo TokenCredential nebo None

Přihlašovací údaje, pomocí kterých se má ověřit. Tato možnost je volitelná, pokud adresa URL účtu už token SAS má. Hodnota může být jedna z azureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) nebo TokenCredential implementace z azure-identity.

api_version: str

Verze rozhraní API služby Storage, která se má použít pro požadavky. Výchozí hodnota je 2019-02-02. Nastavení na starší verzi může mít za následek snížení kompatibility funkcí.

endpoint: str

Vyžadováno

Adresa URL účtu Azure Tables.

credential: AzureNamedKeyCredential nebo AzureSasCredential nebo TokenCredential nebo None

api_version: str nebo None

Určuje verzi operace, která se má použít pro tento požadavek. Výchozí hodnota je "2019-02-02".

Příklady

Ověřování TableServiceClient ze sdíleného přístupového klíče


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

Ověřování klienta TableServiceClient ze sdíleného klíče účtu


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

Proměnné

account_name: str

Název účtu Tables.

url: str

Úplná adresa URL účtu Tables.

Metody

close	Tato metoda slouží k zavření soketů otevřených klientem. Nemusí se používat při použití se správcem kontextu.
create_table	Vytvoří novou tabulku pod aktuálním účtem.
create_table_if_not_exists	Vytvoří novou tabulku, pokud aktuálně neexistuje. Pokud tabulka aktuálně existuje, vrátí se aktuální tabulka.
delete_table	Odstraní tabulku pod aktuálním účtem. Pokud se daná tabulka nenajde, nebude vyvolána žádná chyba.
from_connection_string	Vytvořte TableServiceClient z připojovacího řetězce.
get_service_properties	Získá vlastnosti služby Table service účtu, včetně vlastností pro analýzu a pravidla CORS (Sdílení prostředků mezi zdroji).
get_service_stats	Načte statistiky související s replikací pro službu Table. Je k dispozici pouze v sekundárním koncovém bodu umístění, pokud je pro účet povolená geograficky redundantní replikace s přístupem pro čtení.
get_table_client	Získejte klienta pro interakci se zadanou tabulkou. Tabulka ještě nemusí existovat.
list_tables	Dotazuje tabulky pod daným účtem.
query_tables	Dotazuje tabulky pod daným účtem.
set_service_properties	Nastaví vlastnosti pro koncový bod služby Table Service účtu, včetně vlastností pro pravidla analýzy a CORS (Sdílení prostředků mezi zdroji).

close

Tato metoda slouží k zavření soketů otevřených klientem. Nemusí se používat při použití se správcem kontextu.

close() -> None

create_table

Vytvoří novou tabulku pod aktuálním účtem.

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

Parametry

table_name: str

Vyžadováno

Název tabulky.

Návraty

TableClient

Návratový typ

TableClient

Výjimky

ResourceExistsError

Příklady

Vytvoření tabulky z objektu 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

Vytvoří novou tabulku, pokud aktuálně neexistuje. Pokud tabulka aktuálně existuje, vrátí se aktuální tabulka.

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

Parametry

table_name: str

Vyžadováno

Název tabulky.

Návraty

TableClient

Návratový typ

TableClient

Výjimky

HttpResponseError

Příklady

Vytvoření tabulky, pokud neexistuje, z objektu 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

Odstraní tabulku pod aktuálním účtem. Pokud se daná tabulka nenajde, nebude vyvolána žádná chyba.

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

Parametry

table_name: str

Vyžadováno

Název tabulky.

Návraty

Žádné

Výjimky

HttpResponseError

Příklady

Odstranění tabulky z objektu 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

Vytvořte TableServiceClient z připojovacího řetězce.

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

Parametry

conn_str: str

Vyžadováno

Připojovací řetězec k účtu služby Azure Storage nebo Cosmos.

Návraty

Klient služby Table Service.

Návratový typ

TableServiceClient

Příklady

Ověřování klienta TableServiceClient ze 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

Získá vlastnosti služby Table service účtu, včetně vlastností pro analýzu a pravidla CORS (Sdílení prostředků mezi zdroji).

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

Návraty

Slovník vlastností služby

Návratový typ

dict[str, object]

Výjimky

HttpResponseError

get_service_stats

Načte statistiky související s replikací pro službu Table. Je k dispozici pouze v sekundárním koncovém bodu umístění, pokud je pro účet povolená geograficky redundantní replikace s přístupem pro čtení.

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

Návraty

Slovník statistik služby

Návratový typ

dict[str, object]

Výjimky

azure.core.exceptions.HttpResponseError:

get_table_client

Získejte klienta pro interakci se zadanou tabulkou.

Tabulka ještě nemusí existovat.

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

Parametry

table_name: str

Vyžadováno

Název tabulky

Návraty

Objekt TableClient .

Návratový typ

TableClient

list_tables

Dotazuje tabulky pod daným účtem.

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

Parametry

results_per_page: int

Počet tabulek na stránku ve vrácených itemPaged

Návraty

Iterátor TableItem

Návratový typ

ItemPaged[TableItem]

Výjimky

HttpResponseError

Příklady

Výpis všech tabulek v účtu úložiště


   # 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

Dotazuje tabulky pod daným účtem.

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

Parametry

query_filter: str

Vyžadováno

Zadejte filtr pro vrácení určitých tabulek.

results_per_page: int

Počet tabulek na stránku ve návratu ItemPaged

parameters: dict[str, Any]

Slovník pro formátovací dotaz s dalšími uživatelem definovanými parametry

Návraty

Iterátor TableItem

Návratový typ

ItemPaged[TableItem]

Výjimky

HttpResponseError

Příklady

Dotazování tabulek v účtu úložiště


   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

Nastaví vlastnosti pro koncový bod služby Table Service účtu, včetně vlastností pro pravidla analýzy a CORS (Sdílení prostředků mezi zdroji).

set_service_properties(**kwargs) -> None

Parametry

analytics_logging: TableAnalyticsLogging

Vlastnosti pro analýzu

hour_metrics: TableMetrics

Metriky na úrovni hodin

minute_metrics: TableMetrics

Metriky na úrovni minut

cors: list[TableCorsRule]

Pravidla sdílení prostředků mezi zdroji

Návraty

Žádné

Výjimky

HttpResponseError

Atributy

api_version

Verze rozhraní API služby Storage, která se používá pro požadavky.

Návraty

Verze rozhraní API služby Storage.

url

Úplná adresa URL koncového bodu pro tuto entitu, včetně tokenu SAS, pokud je použit.

To může být primární koncový bod nebo sekundární koncový bod v závislosti na aktuálním <xref:azure.data.tables.location_mode>.

Návraty

Úplná adresa URL koncového bodu včetně tokenu SAS, pokud je použita.

Návratový typ

str

Sdílet prostřednictvím

TableServiceClient Třída

Konstruktor

Parametry

Příklady

Proměnné

Metody

close

create_table

Parametry

Návraty

Návratový typ

Výjimky

Příklady

create_table_if_not_exists

Parametry

Návraty

Návratový typ

Výjimky

Příklady

delete_table

Parametry

Návraty

Výjimky

Příklady

from_connection_string

Parametry

Návraty

Návratový typ

Příklady

get_service_properties

Návraty

Návratový typ

Výjimky

get_service_stats

Návraty

Návratový typ

Výjimky

get_table_client

Parametry

Návraty

Návratový typ

list_tables

Parametry

Návraty

Návratový typ

Výjimky

Příklady

query_tables

Parametry

Návraty

Návratový typ

Výjimky

Příklady

set_service_properties

Parametry

Návraty

Výjimky

Atributy

api_version

Návraty

url

Návraty

Návratový typ

Další materiály