Merge pull request #4 from microsoft/user/jeffand/prefix

Simplify batch create scenarios

Author: zhaodongwang-msft

examples/quickstart.py

@@ -58,11 +58,12 @@ def backoff_retry(op, *, delays=(0, 2, 5, 10, 20), retry_http_statuses=(400, 403
 table_info = None
 created_this_run = False
 
-# First check for existing table
-log_call("client.get_table_info('SampleItem')")
-existing = client.get_table_info("SampleItem")
-if existing:
-	table_info = existing
+# Check for existing table using list_tables
+log_call("client.list_tables()")
+tables = client.list_tables()
+existing_table = next((t for t in tables if t.get("SchemaName") == "new_SampleItem"), None)
+if existing_table:
+	table_info = client.get_table_info("new_SampleItem")
 	created_this_run = False
 	print({
 		"table": table_info.get("entity_schema"),
@@ -71,13 +72,12 @@ def backoff_retry(op, *, delays=(0, 2, 5, 10, 20), retry_http_statuses=(400, 403
 		"logical": table_info.get("entity_logical_name"),
 		"metadata_id": table_info.get("metadata_id"),
 	})
-
 else:
 	# Create it since it doesn't exist
 	try:
 		log_call("client.create_table('SampleItem', schema={code,count,amount,when,active})")
 		table_info = client.create_table(
-			"SampleItem",
+			"new_SampleItem",
 			{
 				"code": "string",
 				"count": "int",
@@ -139,12 +139,8 @@ def print_line_summaries(label: str, summaries: list[dict]) -> None:
 
 # 2) Create a record in the new table
 print("Create records (OData):")
-# Show planned creates before executing
-for _ in range(3):
-	plan_call(f"client.create('{entity_set}', payload)")
-pause("Execute Create")
-record_ids: list[str] = []
-created_recs: list[dict] = []
+
+# Prepare payloads
 create_payloads = [
 	{
 		f"{attr_prefix}_name": "Sample A",
@@ -172,14 +168,41 @@ def print_line_summaries(label: str, summaries: list[dict]) -> None:
 	},
 ]
 
+# Show planned creates before executing
+plan_call(f"client.create('{entity_set}', single_payload)")
+plan_call(f"client.create('{entity_set}', [payload, ...])")
+pause("Execute Create")
+record_ids: list[str] = []
+created_recs: list[dict] = []
+
 try:
-	for payload in create_payloads:
-		log_call(f"client.create('{entity_set}', payload)")
-		rec = backoff_retry(lambda p=payload: client.create(entity_set, p))
-		created_recs.append(rec)
-		rid = rec.get(id_key)
-		if rid:
-			record_ids.append(rid)
+	# Create the first record
+	single_payload = create_payloads[0]
+	log_call(f"client.create('{entity_set}', single_payload)")
+	rec = backoff_retry(lambda: client.create(entity_set, single_payload))
+	created_recs.append(rec)
+	rid = rec.get(id_key)
+	if rid:
+		record_ids.append(rid)
+
+	# Create the remaining records in a single batch call
+	batch_payloads = create_payloads[1:]
+	if batch_payloads:
+		log_call(f"client.create('{entity_set}', batch_payloads)")
+		batch_recs = backoff_retry(lambda: client.create(entity_set, batch_payloads))
+		# If the batch call returns a list, extend; else, append
+		if isinstance(batch_recs, list):
+			created_recs.extend(batch_recs)
+			for rec in batch_recs:
+				rid = rec.get(id_key)
+				if rid:
+					record_ids.append(rid)
+		else:
+			created_recs.append(batch_recs)
+			rid = batch_recs.get(id_key)
+			if rid:
+				record_ids.append(rid)
+
 	print({"entity": logical, "created_ids": record_ids})
 	# Summarize the created records from the returned payloads
 	summaries = []
@@ -321,11 +344,11 @@ def _retry_if(ex: Exception) -> bool:
 print("Cleanup (Metadata):")
 try:
 	# Delete if present, regardless of whether it was created in this run
-	log_call("client.get_table_info('SampleItem')")
-	info = client.get_table_info("SampleItem")
+	log_call("client.get_table_info('new_SampleItem')")
+	info = client.get_table_info("new_SampleItem")
 	if info:
-		log_call("client.delete_table('SampleItem')")
-		client.delete_table("SampleItem")
+		log_call("client.delete_table('new_SampleItem')")
+		client.delete_table("new_SampleItem")
 		print({"table_deleted": True})
 	else:
 		print({"table_deleted": False, "reason": "not found"})

src/dataverse_sdk/client.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, List, Union
 
 from azure.core.credentials import TokenCredential
 
@@ -63,25 +63,29 @@ def _get_odata(self) -> ODataClient:
         return self._odata
 
     # CRUD
-    def create(self, entity: str, record_data: dict) -> dict:
-        """Create a record and return its full representation.
+    def create(self, entity: str, record_data: Union[Dict[str, Any], List[Dict[str, Any]], Any]) -> Union[Dict[str, Any], List[Dict[str, Any]]]:
+        """Create one or more records and return their full representation(s).
 
         Parameters
         ----------
         entity : str
             Entity set name (plural logical name), e.g., ``"accounts"``.
-        record_data : dict
-            Field-value pairs to set on the new record.
+        record_data : dict, list of dict, or pandas.DataFrame
+            Single record (dict), list of records, or pandas DataFrame with field-value pairs.
 
         Returns
         -------
-        dict
-            The created record as returned by the Web API (``Prefer: return=representation``).
+        dict or list of dict
+            For single record: the created record as returned by the Web API.
+            For multiple records: list of created records.
+            Records are created using batch requests with a batch size of 25 for optimal performance.
 
         Raises
         ------
         requests.exceptions.HTTPError
             If the request fails (via ``raise_for_status`` in the underlying client).
+        TypeError
+            If record_data is not a supported type (dict, list, or pandas DataFrame).
         """
         return self._get_odata().create(entity, record_data)
 
@@ -196,6 +200,15 @@ def delete_table(self, tablename: str) -> None:
         """
         self._get_odata().delete_table(tablename)
 
+    def list_tables(self) -> list[str]:
+        """List all custom tables in the Dataverse environment.
+
+        Returns
+        -------
+        list[str]
+            A list of table names.
+        """
+        return self._get_odata().list_tables()
 
 __all__ = ["DataverseClient"]