TableServiceClient Kelas

Referensi

Klien untuk berinteraksi dengan Layanan Tabel di tingkat akun.

Klien ini menyediakan operasi untuk mengambil dan mengonfigurasi properti akun serta mencantumkan, membuat dan menghapus tabel dalam akun. Untuk operasi yang berkaitan dengan tabel tertentu, klien untuk entitas ini dapat diambil menggunakan get_table_client fungsi .

Buat TablesBaseClient dari Kredensial.

Warisan: azure.data.tables._base_client.TablesBaseClient

TableServiceClient

Konstruktor

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

Parameter

endpoint: str

Diperlukan

URL ke titik akhir layanan tabel. Entitas lain yang disertakan dalam jalur URL (misalnya tabel) akan dibuang. URL ini dapat diautentikasi secara opsional dengan token SAS.

credential: AzureNamedKeyCredential atau AzureSasCredential atau TokenCredential atau None

Kredensial yang digunakan untuk mengautentikasi. Ini bersifat opsional jika URL akun sudah memiliki token SAS. Nilainya bisa menjadi salah satu AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core), atau implementasi TokenCredential dari azure-identity.

api_version: str

Versi Storage API yang digunakan untuk permintaan. Nilai defaultnya adalah '2019-02-02'. Pengaturan ke versi yang lebih lama dapat mengakibatkan kompatibilitas fitur yang berkurang.

endpoint: str

Diperlukan

URL ke akun Azure Tables.

credential: AzureNamedKeyCredential atau AzureSasCredential atau TokenCredential atau None

api_version: str atau None

Menentukan versi operasi yang akan digunakan untuk permintaan ini. Nilai defaultnya adalah "2019-02-02".

Contoh

Mengautentikasi TableServiceClient dari Kunci Akses Bersama


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

Mengautentikasi TableServiceClient dari Kunci Akun Bersama


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

Variabel

account_name: str

Nama akun Tabel.

url: str

URL lengkap ke akun Tabel.

Metode

close	Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks.
create_table	Membuat tabel baru di bawah akun saat ini.
create_table_if_not_exists	Membuat tabel baru jika saat ini tidak ada. Jika tabel saat ini ada, tabel saat ini dikembalikan.
delete_table	Menghapus tabel di bawah akun saat ini. Tidak ada kesalahan yang akan dimunculkan jika tabel yang diberikan tidak ditemukan.
from_connection_string	Buat TableServiceClient dari string koneksi.
get_service_properties	Mendapatkan properti layanan Tabel akun, termasuk properti untuk aturan Analytics dan CORS (Cross-Origin Resource Sharing).
get_service_stats	Mengambil statistik yang terkait dengan replikasi untuk layanan Tabel. Ini hanya tersedia di titik akhir lokasi sekunder ketika replikasi geo-redundan akses baca diaktifkan untuk akun.
get_table_client	Mendapatkan klien untuk berinteraksi dengan tabel yang ditentukan. Tabel belum ada.
list_tables	Tabel kueri di bawah akun yang diberikan.
query_tables	Tabel kueri di bawah akun yang diberikan.
set_service_properties	Mengatur properti untuk titik akhir layanan Tabel akun, termasuk properti untuk aturan Analytics dan CORS (Cross-Origin Resource Sharing).

close

Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks.

close() -> None

create_table

Membuat tabel baru di bawah akun saat ini.

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

Parameter

table_name: str

Diperlukan

Nama Tabel.

Mengembalikan

TableClient

Tipe hasil

TableClient

Pengecualian

ResourceExistsError

Contoh

Membuat tabel dari objek 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

Membuat tabel baru jika saat ini tidak ada. Jika tabel saat ini ada, tabel saat ini dikembalikan.

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

Parameter

table_name: str

Diperlukan

Nama Tabel.

Mengembalikan

TableClient

Tipe hasil

TableClient

Pengecualian

HttpResponseError

Contoh

Membuat tabel jika tidak ada, dari objek 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

Menghapus tabel di bawah akun saat ini. Tidak ada kesalahan yang akan dimunculkan jika tabel yang diberikan tidak ditemukan.

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

Parameter

table_name: str

Diperlukan

Nama Tabel.

Mengembalikan

Tidak ada

Pengecualian

HttpResponseError

Contoh

Menghapus tabel dari objek 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

Buat TableServiceClient dari string koneksi.

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

Parameter

conn_str: str

Diperlukan

String koneksi ke akun Azure Storage atau Cosmos.

Mengembalikan

Klien layanan Tabel.

Tipe hasil

TableServiceClient

Contoh

Mengautentikasi TableServiceClient dari 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

Mendapatkan properti layanan Tabel akun, termasuk properti untuk aturan Analytics dan CORS (Cross-Origin Resource Sharing).

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

Mengembalikan

Kamus properti layanan

Tipe hasil

dict[str, object]

Pengecualian

HttpResponseError

get_service_stats

Mengambil statistik yang terkait dengan replikasi untuk layanan Tabel. Ini hanya tersedia di titik akhir lokasi sekunder ketika replikasi geo-redundan akses baca diaktifkan untuk akun.

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

Mengembalikan

Kamus statistik layanan

Tipe hasil

dict[str, object]

Pengecualian

azure.core.exceptions.HttpResponseError:

get_table_client

Mendapatkan klien untuk berinteraksi dengan tabel yang ditentukan.

Tabel belum ada.

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

Parameter

table_name: str

Diperlukan

Nama tabel

Mengembalikan

Objek TableClient.

Tipe hasil

TableClient

list_tables

Tabel kueri di bawah akun yang diberikan.

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

Parameter

results_per_page: int

Jumlah tabel per halaman dalam ItemPaged yang dikembalikan

Mengembalikan

Iterator dari TableItem

Tipe hasil

ItemPaged[TableItem]

Pengecualian

HttpResponseError

Contoh

Mencantumkan semua tabel di akun penyimpanan


   # 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

Tabel kueri di bawah akun yang diberikan.

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

Parameter

query_filter: str

Diperlukan

Tentukan filter untuk mengembalikan tabel tertentu.

results_per_page: int

Jumlah tabel per halaman dalam pengembalian ItemPaged

parameters: dict[str, Any]

Kamus untuk memformat kueri dengan parameter tambahan yang ditentukan pengguna

Mengembalikan

Iterator dari TableItem

Tipe hasil

ItemPaged[TableItem]

Pengecualian

HttpResponseError

Contoh

Mengkueri tabel di akun penyimpanan


   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

Mengatur properti untuk titik akhir layanan Tabel akun, termasuk properti untuk aturan Analytics dan CORS (Cross-Origin Resource Sharing).

set_service_properties(**kwargs) -> None

Parameter

analytics_logging: TableAnalyticsLogging

Properti untuk analitik

hour_metrics: TableMetrics

Metrik tingkat jam

minute_metrics: TableMetrics

Metrik tingkat menit

cors: list[TableCorsRule]

Aturan berbagi sumber daya lintas asal

Mengembalikan

Tidak ada

Pengecualian

HttpResponseError

Atribut

api_version

Versi STORAGE API yang digunakan untuk permintaan.

Mengembalikan

Versi Storage API.

url

URL titik akhir lengkap untuk entitas ini, termasuk token SAS jika digunakan.

Ini bisa berupa titik akhir utama, atau titik akhir sekunder tergantung pada saat ini <xref:azure.data.tables.location_mode>.

Mengembalikan

URL titik akhir lengkap termasuk token SAS jika digunakan.

Tipe hasil

str

Bagikan melalui

TableServiceClient Kelas

Konstruktor

Parameter

Contoh

Variabel

Metode

close

create_table

Parameter

Mengembalikan

Tipe hasil

Pengecualian

Contoh

create_table_if_not_exists

Parameter

Mengembalikan

Tipe hasil

Pengecualian

Contoh

delete_table

Parameter

Mengembalikan

Pengecualian

Contoh

from_connection_string

Parameter

Mengembalikan

Tipe hasil

Contoh

get_service_properties

Mengembalikan

Tipe hasil

Pengecualian

get_service_stats

Mengembalikan

Tipe hasil

Pengecualian

get_table_client

Parameter

Mengembalikan

Tipe hasil

list_tables

Parameter

Mengembalikan

Tipe hasil

Pengecualian

Contoh

query_tables

Parameter

Mengembalikan

Tipe hasil

Pengecualian

Contoh

set_service_properties

Parameter

Mengembalikan

Pengecualian

Atribut

api_version

Mengembalikan

url

Mengembalikan

Tipe hasil

Saran dan Komentar

Sumber Daya Tambahan: