TableClient Klass

En klient som ska interagera med en specifik tabell i ett Azure Tables-konto.

Skapa TableClient från en autentiseringsuppgift.

Arv

azure.data.tables._base_client.TablesBaseClient

TableClient

Konstruktor

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

Parametrar

endpoint

str

Obligatorisk

En URL till ett Azure Tables-konto.

table_name

str

Obligatorisk

Tabellnamnet.

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

Anger vilken version av åtgärden som ska användas för den här begäran. Standardvärdet är "2019-02-02".

Variabler

account_name

str

Namnet på kontot Tabeller.

table_name

str

Namnet på tabellen.

scheme

str

Schemakomponenten i den fullständiga URL:en till tabellkontot.

url

str

Lagringsslutpunkten.

api_version

str

Tjänstens API-version.

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_entity	Infoga entitet i en tabell.
create_table	Skapar en ny tabell under det aktuella kontot.
delete_entity	Tar bort den angivna entiteten i en tabell. Inget fel utlöses om entiteten eller PartitionKey-RowKey parkopplingen inte hittas.
delete_table	Tar bort tabellen under det aktuella kontot. Inget fel utlöses om tabellen inte finns
from_connection_string	Skapa TableClient från en anslutningssträng.
from_table_url	En klient för att interagera med en specifik tabell. AzureSasCredential (azure-core) eller en TokenCredential-implementering från azure-identity. :p aramtype-autentiseringsuppgifter: ~azure.core.credentials.AzureNamedKeyCredential eller ~azure.core.credentials.AzureSasCredential eller None
get_entity	Hämta en enda entitet i en tabell.
get_table_access_policy	Hämtar information om lagrade åtkomstprinciper som anges i tabellen som kan användas med signaturer för delad åtkomst.
list_entities	Visar entiteter i en tabell.
query_entities	Visar entiteter i en tabell.
set_table_access_policy	Anger lagrade åtkomstprinciper för tabellen som kan användas med signaturer för delad åtkomst.
submit_transaction	Checka in en lista över åtgärder som en enda transaktion. Om någon av dessa åtgärder misslyckas avvisas hela transaktionen.
update_entity	Uppdatera entiteten i en tabell.
upsert_entity	Uppdatera/sammanfoga eller infoga entiteten i tabellen.

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

create_entity

Infoga entitet i en tabell.

create_entity(entity: TableEntity | Mapping[str, Any], **kwargs) -> Dict[str, Any]

Parametrar

entity

Union[TableEntity, Mapping[str, Any]]

Obligatorisk

Egenskaperna för tabellentiteten.

Returer

Metadata för ordlistemappningsåtgärden som returneras från tjänsten

Returtyp

dict[str, Any]

Undantag

HttpResponseError

Exempel

Skapa och lägga till en entitet i en tabell

   try:
       resp = table_client.create_entity(entity=self.entity)
       print(resp)
   except ResourceExistsError:
       print("Entity already exists")

create_table

Skapar en ny tabell under det aktuella kontot.

create_table(**kwargs) -> TableItem

Returer

En TableItem som representerar den skapade tabellen.

Returtyp

TableItem

Undantag

ResourceExistsError

Om entiteten redan finns

Exempel

Skapa en tabell från TableClient-objektet

   with TableClient.from_connection_string(
       conn_str=self.connection_string, table_name=self.table_name
   ) as table_client:
       try:
           table_item = table_client.create_table()
           print("Created table {}!".format(table_item.name))
       except ResourceExistsError:
           print("Table already exists")

delete_entity

Tar bort den angivna entiteten i en tabell. Inget fel utlöses om entiteten eller PartitionKey-RowKey parkopplingen inte hittas.

delete_entity(partition_key: str, row_key: str, **kwargs) -> None

Parametrar

partition_key

str

Obligatorisk

Partitionsnyckeln för entiteten.

row_key

str

Obligatorisk

Radnyckeln för entiteten.

entity

Union[TableEntity, Mapping[str, str]]

Obligatorisk

Entiteten som ska tas bort

etag

str

Etag för entiteten

match_condition

MatchConditions

Villkoret under vilket åtgärden ska utföras. Värden som stöds är: MatchConditions.IfNotModified, MatchConditions.Ovillkorligt. Standardvärdet är Villkorslöst.

Returer

Ingen

Undantag

HttpResponseError

Exempel

Ta bort en entitet i en tabell

   table_client.delete_entity(row_key=self.entity["RowKey"], partition_key=self.entity["PartitionKey"])
   print("Successfully deleted!")

delete_table

Tar bort tabellen under det aktuella kontot. Inget fel utlöses om tabellen inte finns

delete_table(**kwargs) -> None

Returer

Ingen

Undantag

HttpResponseError

Exempel

Ta bort en tabell från TableClient-objektet

   with TableClient.from_connection_string(
       conn_str=self.connection_string, table_name=self.table_name
   ) as table_client:
       table_client.delete_table()
       print("Deleted table {}!".format(table_client.table_name))

from_connection_string

Skapa TableClient från en anslutningssträng.

from_connection_string(conn_str: str, table_name: str, **kwargs) -> TableClient

Parametrar

conn_str

str

Obligatorisk

En anslutningssträng till ett Azure Tables-konto.

table_name

str

Obligatorisk

Tabellnamnet.

Returer

En tabellklient.

Returtyp

TableClient

Exempel

Autentisera en TableServiceClient från en connection_string

   from azure.data.tables import TableClient

   with TableClient.from_connection_string(
       conn_str=self.connection_string, table_name="tableName"
   ) as table_client:
       print("Table name: {}".format(table_client.table_name))

from_table_url

En klient för att interagera med en specifik tabell.

AzureSasCredential (azure-core) eller en TokenCredential-implementering från azure-identity. :p aramtype-autentiseringsuppgifter:

~azure.core.credentials.AzureNamedKeyCredential eller ~azure.core.credentials.AzureSasCredential eller None

from_table_url(table_url: str, *, credential: AzureNamedKeyCredential | AzureSasCredential | None = None, **kwargs) -> TableClient

Parametrar

table_url

Obligatorisk

Returer

En tabellklient.

Returtyp

TableClient

get_entity

Hämta en enda entitet i en tabell.

get_entity(partition_key: str, row_key: str, **kwargs) -> TableEntity

Parametrar

partition_key

str

Obligatorisk

Partitionsnyckeln för entiteten.

row_key

str

Obligatorisk

Radnyckeln för entiteten.

select

str eller list[str]

Ange önskade egenskaper för en entitet som ska returneras.

Returer

Metadata för ordlistemappningsåtgärden som returneras från tjänsten

Returtyp

TableEntity

Undantag

HttpResponseError

Exempel

Hämta en entitet från en tabell

   # Get Entity by partition and row key
   got_entity = table.get_entity(partition_key=my_entity["PartitionKey"], row_key=my_entity["RowKey"])
   print("Received entity: {}".format(got_entity))

get_table_access_policy

Hämtar information om lagrade åtkomstprinciper som anges i tabellen som kan användas med signaturer för delad åtkomst.

get_table_access_policy(**kwargs) -> Dict[str, TableAccessPolicy | None]

Returer

Ordlista för SignedIdentifiers

Returtyp

dict[str, TableAccessPolicy],

dict[str, None]

Undantag

HttpResponseError

list_entities

Visar entiteter i en tabell.

list_entities(**kwargs) -> ItemPaged[TableEntity]

Parametrar

results_per_page

int

Antal entiteter som returneras per tjänstbegäran.

select

str eller list[str]

Ange önskade egenskaper för en entitet som ska returneras.

Returer

En iterator för TableEntity

Returtyp

ItemPaged[TableEntity]

Undantag

HttpResponseError

Exempel

Visa en lista över alla entiteter som finns i en tabell

   # Query the entities in the table
   entities = list(table.list_entities())
   for i, entity in enumerate(entities):
       print("Entity #{}: {}".format(entity, i))

query_entities

Visar entiteter i en tabell.

query_entities(query_filter: str, **kwargs) -> ItemPaged[TableEntity]

Parametrar

query_filter

str

Obligatorisk

Ange ett filter för att returnera vissa entiteter. Mer information om filterformatering finns i exempeldokumentationen.

results_per_page

int

Antal entiteter som returneras per tjänstbegäran.

select

str eller list[str]

Ange önskade egenskaper för en entitet som ska returneras.

parameters

dict[str, Any]

Ordlista för formateringsfråga med ytterligare användardefinierade parametrar

Returer

En iterator för TableEntity

Returtyp

ItemPaged[TableEntity]

Undantag

HttpResponseError

Exempel

Fråga entiteter som finns i en tabell

   with TableClient.from_connection_string(self.connection_string, self.table_name) as table_client:
       try:
           print("Basic sample:")
           print("Entities with name: marker")
           parameters = {"name": "marker"}
           name_filter = "Name eq @name"
           queried_entities = table_client.query_entities(
               query_filter=name_filter, select=["Brand", "Color"], parameters=parameters
           )

           for entity_chosen in queried_entities:
               print(entity_chosen)

           print("Sample for querying entities withtout metadata:")
           print("Entities with name: marker")
           parameters = {"name": "marker"}
           name_filter = "Name eq @name"
           headers = {"Accept": "application/json;odata=nometadata"}
           queried_entities = table_client.query_entities(
               query_filter=name_filter, select=["Brand", "Color"], parameters=parameters, headers=headers
           )
           for entity_chosen in queried_entities:
               print(entity_chosen)

           print("Sample for querying entities with multiple params:")
           print("Entities with name: marker and brand: Crayola")
           parameters = {"name": "marker", "brand": "Crayola"}
           name_filter = "Name eq @name and Brand eq @brand"
           queried_entities = table_client.query_entities(
               query_filter=name_filter, select=["Brand", "Color"], parameters=parameters
           )
           for entity_chosen in queried_entities:
               print(entity_chosen)

           print("Sample for querying entities' values:")
           print("Entities with 25 < Value < 50")
           parameters = {"lower": 25, "upper": 50}  # type: ignore
           name_filter = "Value gt @lower and Value lt @upper"
           queried_entities = table_client.query_entities(
               query_filter=name_filter, select=["Value"], parameters=parameters
           )
           for entity_chosen in queried_entities:
               print(entity_chosen)
       except HttpResponseError as e:
           raise

set_table_access_policy

Anger lagrade åtkomstprinciper för tabellen som kan användas med signaturer för delad åtkomst.

set_table_access_policy(signed_identifiers: Dict[str, TableAccessPolicy | None], **kwargs) -> None

Parametrar

signed_identifiers

dict[str, TableAccessPolicy] eller dict[str, None]

Obligatorisk

Åtkomstprinciper som ska anges för tabellen

Returer

Ingen

Undantag

HttpResponseError

submit_transaction

Checka in en lista över åtgärder som en enda transaktion.

Om någon av dessa åtgärder misslyckas avvisas hela transaktionen.

submit_transaction(operations: Iterable[Tuple[TransactionOperation | str, TableEntity | Mapping[str, Any]] | Tuple[TransactionOperation | str, TableEntity | Mapping[str, Any], Mapping[str, Any]]], **kwargs) -> List[Mapping[str, Any]]

Parametrar

operations

Iterable[Tuple[str, TableEntity, Mapping[str, Any]]]

Obligatorisk

Listan över åtgärder som ska genomföras i en transaktion. Detta bör vara en iterabel av tupplar som innehåller ett åtgärdsnamn, den entitet som ska användas och eventuellt en diktering av ytterligare kwargs för den åtgärden. Exempel:

   - ('upsert', {'PartitionKey': 'A', 'RowKey': 'B'})
   - ('upsert', {'PartitionKey': 'A', 'RowKey': 'B'}, {'mode': UpdateMode.REPLACE})

Returer

En lista över mappningar med svarsmetadata för varje åtgärd i transaktionen.

Returtyp

list[Mapping[str, Any]]

Undantag

TableTransactionError

Exempel

Använda transaktioner för att skicka flera begäranden samtidigt

   from azure.data.tables import TableClient, TableTransactionError
   from azure.core.exceptions import ResourceExistsError

   self.table_client = TableClient.from_connection_string(
       conn_str=self.connection_string, table_name=self.table_name
   )

   try:
       self.table_client.create_table()
       print("Created table")
   except ResourceExistsError:
       print("Table already exists")

   self.table_client.upsert_entity(entity2)
   self.table_client.upsert_entity(entity3)
   self.table_client.upsert_entity(entity4)

   operations = [
       ("upsert", entity1),
       ("delete", entity2),
       ("upsert", entity3),
       ("update", entity4, {"mode": "replace"}),
   ]
   try:
       self.table_client.submit_transaction(operations)  # type: ignore[arg-type]
   except TableTransactionError as e:
       print("There was an error with the transaction operation")
       print(e)

update_entity

Uppdatera entiteten i en tabell.

update_entity(entity: TableEntity | Mapping[str, Any], mode: UpdateMode = UpdateMode.MERGE, **kwargs) -> Dict[str, Any]

Parametrar

entity

TableEntity eller dict[str, Any]

Obligatorisk

Egenskaperna för tabellentiteten.

mode

UpdateMode

Obligatorisk

Sammanfoga eller ersätta entitet

etag

str

Etag för entiteten

match_condition

MatchConditions

Villkoret under vilket åtgärden ska utföras. Värden som stöds är: MatchConditions.IfNotModified, MatchConditions.Ovillkorligt. Standardvärdet är Villkorslöst.

Returer

Metadata för ordlistemappningsåtgärden som returneras från tjänsten

Returtyp

dict[str, Any]

Undantag

HttpResponseError

Exempel

Uppdatera en redan avslutad entitet i en tabell

   # Update the entity
   created["text"] = "NewMarker"
   table.update_entity(mode=UpdateMode.REPLACE, entity=created)

   # Get the replaced entity
   replaced = table.get_entity(partition_key=created["PartitionKey"], row_key=created["RowKey"])
   print("Replaced entity: {}".format(replaced))

   # Merge the entity
   replaced["color"] = "Blue"
   table.update_entity(mode=UpdateMode.MERGE, entity=replaced)

   # Get the merged entity
   merged = table.get_entity(partition_key=replaced["PartitionKey"], row_key=replaced["RowKey"])
   print("Merged entity: {}".format(merged))

upsert_entity

Uppdatera/sammanfoga eller infoga entiteten i tabellen.

upsert_entity(entity: TableEntity | Mapping[str, Any], mode: UpdateMode = UpdateMode.MERGE, **kwargs) -> Dict[str, Any]

Parametrar

entity

TableEntity eller dict[str, Any]

Obligatorisk

Egenskaperna för tabellentiteten.

mode

UpdateMode

Obligatorisk

Sammanfoga eller ersätta entitet

Returer

Metadata för ordlistemappningsåtgärden som returneras från tjänsten

Returtyp

dict[str, Any]

Undantag

HttpResponseError

Exempel

Uppdatera/sammanfoga eller infoga en entitet i en tabell

   # Try Replace and insert on fail
   insert_entity = table.upsert_entity(mode=UpdateMode.REPLACE, entity=entity1)
   print("Inserted entity: {}".format(insert_entity))

   created["text"] = "NewMarker"
   merged_entity = table.upsert_entity(mode=UpdateMode.MERGE, entity=entity)
   print("Merged entity: {}".format(merged_entity))

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

str