TableServiceClient الفصل

‏‏المرجع

عميل للتفاعل مع خدمة الجدول على مستوى الحساب.

يوفر هذا العميل عمليات لاسترداد خصائص الحساب وتكوينها بالإضافة إلى القائمة وإنشاء الجداول وحذفها داخل الحساب. بالنسبة للعمليات المتعلقة بجدول معين، يمكن استرداد عميل لهذا الكيان باستخدام الدالة get_table_client .

إنشاء TablesBaseClient من بيانات الاعتماد.

توريث: azure.data.tables._base_client.TablesBaseClient

TableServiceClient

الدالمنشئ

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

المعلمات

endpoint: str

مطلوب

عنوان URL لنقطة نهاية خدمة الجدول. سيتم تجاهل أي كيانات أخرى مضمنة في مسار URL (مثل الجدول). يمكن مصادقة عنوان URL هذا اختياريا باستخدام رمز SAS المميز.

credential: AzureNamedKeyCredential أو AzureSasCredential أو TokenCredential أو None

بيانات الاعتماد التي يجب المصادقة بها. هذا اختياري إذا كان عنوان URL للحساب يحتوي بالفعل على رمز SAS المميز. يمكن أن تكون القيمة واحدة من AzureNamedKeyCredential (azure-core) أو AzureSasCredential (azure-core) أو تنفيذ TokenCredential من azure-identity.

api_version: str

إصدار Storage API لاستخدامه للطلبات. القيمة الافتراضية هي "2019-02-02". قد يؤدي الإعداد إلى إصدار أقدم إلى تقليل توافق الميزات.

endpoint: str

مطلوب

عنوان URL لحساب Azure Tables.

credential: AzureNamedKeyCredential أو AzureSasCredential أو TokenCredential أو None

api_version: str أو None

يحدد إصدار العملية المراد استخدامها لهذا الطلب. القيمة الافتراضية هي "2019-02-02".

أمثلة

مصادقة TableServiceClient من مفتاح الوصول المشترك


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

مصادقة TableServiceClient من مفتاح حساب مشترك


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

المتغيرات

account_name: str

اسم حساب الجداول.

url: str

عنوان URL الكامل لحساب الجداول.

الأساليب

close	هذا الأسلوب هو إغلاق مآخذ التوصيل التي فتحها العميل. لا يلزم استخدامه عند استخدام مع مدير سياق.
create_table	إنشاء جدول جديد ضمن الحساب الحالي.
create_table_if_not_exists	إنشاء جدول جديد إذا لم يكن موجودا حاليا. إذا كان الجدول موجودا حاليا، يتم إرجاع الجدول الحالي.
delete_table	حذف الجدول ضمن الحساب الحالي. لن يتم رفع أي خطأ إذا لم يتم العثور على الجدول المحدد.
from_connection_string	إنشاء TableServiceClient من سلسلة اتصال.
get_service_properties	يحصل على خصائص خدمة جدول الحساب، بما في ذلك خصائص قواعد التحليلات وCORS (مشاركة الموارد عبر المنشأ).
get_service_stats	استرداد الإحصائيات المتعلقة بالنسخ المتماثل لخدمة الجدول. يتوفر فقط على نقطة نهاية الموقع الثانوي عند تمكين النسخ المتماثل المتكرر جغرافيا للوصول للقراءة للحساب.
get_table_client	احصل على عميل للتفاعل مع الجدول المحدد. لا يلزم وجود الجدول بالفعل.
list_tables	الاستعلامات الجداول ضمن الحساب المحدد.
query_tables	الاستعلامات الجداول ضمن الحساب المحدد.
set_service_properties	تعيين خصائص نقطة نهاية خدمة الجدول للحساب، بما في ذلك خصائص قواعد التحليلات وCORS (مشاركة الموارد عبر المنشأ).

close

هذا الأسلوب هو إغلاق مآخذ التوصيل التي فتحها العميل. لا يلزم استخدامه عند استخدام مع مدير سياق.

close() -> None

create_table

إنشاء جدول جديد ضمن الحساب الحالي.

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

المعلمات

table_name: str

مطلوب

اسم الجدول.

المرتجعات

TableClient

نوع الإرجاع

TableClient

استثناءات

ResourceExistsError

أمثلة

إنشاء جدول من عنصر 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

إنشاء جدول جديد إذا لم يكن موجودا حاليا. إذا كان الجدول موجودا حاليا، يتم إرجاع الجدول الحالي.

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

المعلمات

table_name: str

مطلوب

اسم الجدول.

المرتجعات

TableClient

نوع الإرجاع

TableClient

استثناءات

HttpResponseError

أمثلة

إنشاء جدول إذا لم يكن موجودا، من عنصر 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

حذف الجدول ضمن الحساب الحالي. لن يتم رفع أي خطأ إذا لم يتم العثور على الجدول المحدد.

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

المعلمات

table_name: str

مطلوب

اسم الجدول.

المرتجعات

بلا

استثناءات

HttpResponseError

أمثلة

حذف جدول من عنصر 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

إنشاء TableServiceClient من سلسلة اتصال.

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

المعلمات

conn_str: str

مطلوب

سلسلة اتصال بحساب Azure Storage أو Cosmos.

المرتجعات

عميل خدمة جدول.

نوع الإرجاع

TableServiceClient

أمثلة

مصادقة TableServiceClient من 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

يحصل على خصائص خدمة جدول الحساب، بما في ذلك خصائص قواعد التحليلات وCORS (مشاركة الموارد عبر المنشأ).

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

المرتجعات

قاموس خصائص الخدمة

نوع الإرجاع

dict[str, object]

استثناءات

HttpResponseError

get_service_stats

استرداد الإحصائيات المتعلقة بالنسخ المتماثل لخدمة الجدول. يتوفر فقط على نقطة نهاية الموقع الثانوي عند تمكين النسخ المتماثل المتكرر جغرافيا للوصول للقراءة للحساب.

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

المرتجعات

قاموس إحصائيات الخدمة

نوع الإرجاع

dict[str, object]

استثناءات

azure.core.exceptions.HttpResponseError:

get_table_client

احصل على عميل للتفاعل مع الجدول المحدد.

لا يلزم وجود الجدول بالفعل.

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

المعلمات

table_name: str

مطلوب

اسم الجدول

المرتجعات

TableClientعنصر.

نوع الإرجاع

TableClient

list_tables

الاستعلامات الجداول ضمن الحساب المحدد.

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

المعلمات

results_per_page: int

عدد الجداول لكل صفحة في ItemPaged التي تم إرجاعها

المرتجعات

مكرر ل TableItem

نوع الإرجاع

ItemPaged[TableItem]

استثناءات

HttpResponseError

أمثلة

سرد جميع الجداول في حساب تخزين


   # 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

الاستعلامات الجداول ضمن الحساب المحدد.

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

المعلمات

query_filter: str

مطلوب

حدد عامل تصفية لإرجاع جداول معينة.

results_per_page: int

عدد الجداول لكل صفحة في إرجاع ItemPaged

parameters: dict[str, Any]

قاموس لتنسيق الاستعلام باستخدام معلمات إضافية معرفة من قبل المستخدم

المرتجعات

مكرر ل TableItem

نوع الإرجاع

ItemPaged[TableItem]

استثناءات

HttpResponseError

أمثلة

الاستعلام عن الجداول في حساب تخزين


   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

تعيين خصائص نقطة نهاية خدمة الجدول للحساب، بما في ذلك خصائص قواعد التحليلات وCORS (مشاركة الموارد عبر المنشأ).

set_service_properties(**kwargs) -> None

المعلمات

analytics_logging: TableAnalyticsLogging

خصائص التحليلات

hour_metrics: TableMetrics

مقاييس مستوى الساعة

minute_metrics: TableMetrics

مقاييس مستوى الدقيقة

cors: list[TableCorsRule]

قواعد مشاركة الموارد عبر المنشأ

المرتجعات

بلا

استثناءات

HttpResponseError

السمات

api_version

إصدار واجهة برمجة تطبيقات التخزين المستخدمة للطلبات.

المرتجعات

إصدار واجهة برمجة تطبيقات التخزين.

url

عنوان URL الكامل لنقطة النهاية لهذا الكيان، بما في ذلك رمز SAS المميز إذا تم استخدامه.

قد تكون هذه إما نقطة النهاية الأساسية، أو نقطة النهاية الثانوية اعتمادا على الحالية <xref:azure.data.tables.location_mode>.

المرتجعات

عنوان URL الكامل لنقطة النهاية بما في ذلك رمز SAS المميز إذا تم استخدامه.

نوع الإرجاع

str

مشاركة عبر

TableServiceClient الفصل

الدالمنشئ

المعلمات

أمثلة

المتغيرات

الأساليب

close

create_table

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

create_table_if_not_exists

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

delete_table

المعلمات

المرتجعات

استثناءات

أمثلة

from_connection_string

المعلمات

المرتجعات

نوع الإرجاع

أمثلة

get_service_properties

المرتجعات

نوع الإرجاع

استثناءات

get_service_stats

المرتجعات

نوع الإرجاع

استثناءات

get_table_client

المعلمات

المرتجعات

نوع الإرجاع

list_tables

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

query_tables

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

set_service_properties

المعلمات

المرتجعات

استثناءات

السمات

api_version

المرتجعات

url

المرتجعات

نوع الإرجاع

الموارد الإضافية