TableServiceClient Klass
En klient som ska interagera med tabelltjänsten på kontonivå.
Den här klienten tillhandahåller åtgärder för att hämta och konfigurera kontoegenskaper samt lista, skapa och ta bort tabeller i kontot. För åtgärder som är relaterade till en specifik tabell kan en klient för den här entiteten hämtas med hjälp av get_table_client funktionen .
Skapa TablesBaseClient från en autentiseringsuppgift.
- Arv
-
azure.data.tables._base_client.TablesBaseClientTableServiceClient
Konstruktor
TableServiceClient(endpoint: str, *, credential: AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs)Parametrar
- endpoint
- str
URL:en till tabelltjänstens slutpunkt. Alla andra entiteter som ingår i URL-sökvägen (t.ex. tabell) tas bort. Den här URL:en kan även autentiseras med en SAS-token.
- credential
- AzureNamedKeyCredential eller AzureSasCredential eller TokenCredential eller None
De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en av AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) eller en TokenCredential-implementering från azure-identity.
- api_version
- str
Den Storage API-version som ska användas för begäranden. Standardvärdet är "2019-02-02". Om du anger en äldre version kan funktionskompatibiliteten minska.
- credential
- AzureNamedKeyCredential eller AzureSasCredential eller TokenCredential eller None
De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en av AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) eller en TokenCredential-implementering från azure-identity.
Anger vilken version av åtgärden som ska användas för den här begäran. Standardvärdet är "2019-02-02".
Exempel
Autentisera en TableServiceClient från en nyckel för delad åtkomst
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))
Autentisera en TableServiceClient från en delad kontonyckel
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))
Variabler
- account_name
- str
Namnet på tabellkontot.
- url
- str
Den fullständiga URL:en till tabellkontot.
Metoder
| close |
Den här metoden är att stänga de sockets som öppnas av klienten. Den behöver inte användas när du använder med en kontexthanterare. |
| create_table |
Skapar en ny tabell under det aktuella kontot. |
| create_table_if_not_exists |
Skapar en ny tabell om den inte finns för närvarande. Om tabellen för närvarande finns returneras den aktuella tabellen. |
| delete_table |
Tar bort tabellen under det aktuella kontot. Inget fel utlöses om den angivna tabellen inte hittas. |
| from_connection_string |
Skapa TableServiceClient från en anslutningssträng. |
| get_service_properties |
Hämtar egenskaperna för ett kontos tabelltjänst, inklusive egenskaper för analys- och CORS-regler (resursdelning för korsande ursprung). |
| get_service_stats |
Hämtar statistik relaterad till replikering för table-tjänsten. Den är endast tillgänglig på den sekundära platsslutpunkten när geo-redundant replikering med läsbehörighet är aktiverad för kontot. |
| get_table_client |
Hämta en klient för att interagera med den angivna tabellen. Tabellen behöver inte redan finnas. |
| list_tables |
Frågar tabeller under det angivna kontot. |
| query_tables |
Frågar tabeller under det angivna kontot. |
| set_service_properties |
Anger egenskaper för ett kontos tabelltjänstslutpunkt, inklusive egenskaper för analys- och CORS-regler (resursdelning för korsande ursprung). |
close
Den här metoden är att stänga de sockets som öppnas av klienten. Den behöver inte användas när du använder med en kontexthanterare.
close() -> Nonecreate_table
Skapar en ny tabell under det aktuella kontot.
create_table(table_name: str, **kwargs) -> TableClientParametrar
Returer
TableClient
Returtyp
Undantag
Exempel
Skapa en tabell från TableServiceClient-objektet
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
Skapar en ny tabell om den inte finns för närvarande. Om tabellen för närvarande finns returneras den aktuella tabellen.
create_table_if_not_exists(table_name: str, **kwargs) -> TableClientParametrar
Returer
TableClient
Returtyp
Undantag
Exempel
Skapa en tabell om den inte finns från TableServiceClient-objektet
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
Tar bort tabellen under det aktuella kontot. Inget fel utlöses om den angivna tabellen inte hittas.
delete_table(table_name: str, **kwargs) -> NoneParametrar
Returer
Ingen
Undantag
Exempel
Ta bort en tabell från TableServiceClient-objektet
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
Skapa TableServiceClient från en anslutningssträng.
from_connection_string(conn_str: str, **kwargs) -> TableServiceClientParametrar
Returer
En Table Service-klient.
Returtyp
Exempel
Autentisera en TableServiceClient från en 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
Hämtar egenskaperna för ett kontos tabelltjänst, inklusive egenskaper för analys- och CORS-regler (resursdelning för korsande ursprung).
get_service_properties(**kwargs) -> Dict[str, object]Returer
Ordlista för tjänstegenskaper
Returtyp
Undantag
get_service_stats
Hämtar statistik relaterad till replikering för table-tjänsten. Den är endast tillgänglig på den sekundära platsslutpunkten när geo-redundant replikering med läsbehörighet är aktiverad för kontot.
get_service_stats(**kwargs) -> Dict[str, object]Returer
Ordlista över tjänststatistik
Returtyp
Undantag
get_table_client
Hämta en klient för att interagera med den angivna tabellen.
Tabellen behöver inte redan finnas.
get_table_client(table_name: str, **kwargs) -> TableClientParametrar
Returer
Ett TableClient -objekt.
Returtyp
list_tables
Frågar tabeller under det angivna kontot.
list_tables(**kwargs) -> ItemPaged[TableItem]Parametrar
- results_per_page
- int
Antal tabeller per sida i returnerade ItemPaged
Returer
En iterator för TableItem
Returtyp
Undantag
Exempel
Lista alla tabeller i ett lagringskonto
# 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
Frågar tabeller under det angivna kontot.
query_tables(query_filter: str, **kwargs) -> ItemPaged[TableItem]Parametrar
- results_per_page
- int
Antal tabeller per sida i retur itempaged
Ordlista för formateringsfråga med ytterligare användardefinierade parametrar
Returer
En iterator för TableItem
Returtyp
Undantag
Exempel
Köra frågor mot tabeller i ett lagringskonto
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
Anger egenskaper för ett kontos tabelltjänstslutpunkt, inklusive egenskaper för analys- och CORS-regler (resursdelning för korsande ursprung).
set_service_properties(**kwargs) -> NoneParametrar
- analytics_logging
- TableAnalyticsLogging
Egenskaper för analys
- hour_metrics
- TableMetrics
Mått på timnivå
- minute_metrics
- TableMetrics
Mått på minutnivå
- cors
- list[TableCorsRule]
Resursdelningsregler för korsande ursprung
Returer
Ingen
Undantag
Attribut
api_version
Den version av Storage-API:et som används för begäranden.
Returer
Storage API-versionen.
url
Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används.
Detta kan vara antingen den primära slutpunkten eller den sekundära slutpunkten beroende på aktuell <xref:azure.data.tables.location_mode>.
Returer
Den fullständiga slutpunkts-URL:en inklusive SAS-token om den används.
Returtyp
Azure SDK for Python
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för