rename PreparedStatement.execute

Author: leo-altertable

README.md

@@ -60,7 +60,7 @@ print(f"Affected {rows_affected} rows")
 ```python
 # Prepare once, execute multiple times
 with client.prepare("SELECT * FROM users WHERE id = ?") as stmt:
-    result = stmt.execute()
+    result = stmt.query()
     for batch in result:
         print(batch.to_pandas())
 ```

examples/client_usage.py

@@ -14,8 +14,8 @@
 ALTERTABLE_PORT = int(os.getenv("ALTERTABLE_PORT", "443"))
 ALTERTABLE_USERNAME = os.getenv("ALTERTABLE_USERNAME")
 ALTERTABLE_PASSWORD = os.getenv("ALTERTABLE_PASSWORD")
-ALTERTABLE_CATALOG = os.getenv("ALTERTABLE_CATALOG")
-ALTERTABLE_SCHEMA = os.getenv("ALTERTABLE_SCHEMA")
+ALTERTABLE_CATALOG = os.getenv("ALTERTABLE_CATALOG", "memory")
+ALTERTABLE_SCHEMA = os.getenv("ALTERTABLE_SCHEMA", "main")
 ALTERTABLE_TLS = os.getenv("ALTERTABLE_TLS", "true").lower() == "true"
 
 CONNECTION_SETTINGS = {
@@ -45,7 +45,7 @@ def example_basic_query():
 
         # Read results
         for batch in reader:
-            df = batch.data().to_pandas()
+            df = batch.data.to_pandas()
             print(df)
 
     print()
@@ -63,7 +63,7 @@ def example_updates():
         **CONNECTION_SETTINGS,
     ) as client:
         # Create table
-        client.execute("CREATE TABLE users (id INT, name VARCHAR, age INT)")
+        client.execute("CREATE TABLE IF NOT EXISTS users (id INT PRIMARY KEY, name VARCHAR, age INT)")
 
         # Insert
         rows = client.execute("INSERT INTO users (name, age) VALUES ('Alice', 25)")
@@ -96,9 +96,9 @@ def example_prepared_statement():
             # Execute with different parameters
             for user_id in [1, 2, 3]:
                 print(f"Fetching user {user_id}...")
-                reader = stmt.execute(parameters={"id": user_id})
+                reader = stmt.query(parameters={"id": user_id})
                 for batch in reader:
-                    print(batch.data().to_pandas())
+                    print(batch.data.to_pandas())
 
     print()
 
@@ -146,21 +146,23 @@ def example_metadata():
         print("Catalogs:")
         reader = client.get_catalogs()
         for batch in reader:
-            print(batch.to_pandas())
+            print(batch.data.to_pandas())
 
         # Get schemas
         print("\nSchemas:")
-        reader = client.get_schemas(catalog="altertable")
+        reader = client.get_schemas(catalog=ALTERTABLE_CATALOG)
         for batch in reader:
-            print(batch.to_pandas())
+            print(batch.data.to_pandas())
 
         # Get tables
         print("\nTables:")
         reader = client.get_tables(
-            catalog="altertable", schema_pattern="main", table_pattern="user%"
+            catalog=ALTERTABLE_CATALOG,
+            schema_pattern=ALTERTABLE_SCHEMA,
+            table_pattern="user%"
         )
         for batch in reader:
-            print(batch.to_pandas())
+            print(batch.data.to_pandas())
 
     print()
 

src/altertable_flightsql/client.py

@@ -257,7 +257,7 @@ def prepare(
 
         Example:
             >>> stmt = client.prepare("SELECT * FROM users WHERE id = ?")
-            >>> result = stmt.execute(parameters=[42])
+            >>> result = stmt.query(parameters={"id": 42})
         """
         # Create prepared statement request
         request = sql_pb2.ActionCreatePreparedStatementRequest(query=query)
@@ -456,13 +456,13 @@ def __init__(self, client: flight.FlightClient, handle: bytes):
         self._client = client
         self._handle = handle
 
-    def execute(
+    def query(
         self,
         *,
         parameters: Optional[Mapping[str, Any]] = None,
     ) -> flight.FlightStreamReader:
         """
-        Execute the prepared statement.
+        Execute the prepared statement query.
 
         Args:
             parameters: Optional RecordBatch containing parameter values.

tests/test_queries.py

@@ -67,7 +67,7 @@ def test_prepare_and_execute(self, altertable_client: Client, test_table: TableI
             f"SELECT * FROM {test_table.full_name} WHERE id = $id"
         ) as stmt:
             # Execute prepared statement
-            reader = stmt.execute(parameters={"id": 1})
+            reader = stmt.query(parameters={"id": 1})
             table = reader.read_all()
             assert table.num_rows > 0