feat(sql) change SQL API

Author: protocolstardust

docs/docs/content/documentation/IPC.md

@@ -100,7 +100,7 @@ You can send SQL queries to remote tables using the `SQLQuery` class:
 >>> from rayforce import TCPClient
 >>> from rayforce.plugins.sql import SQLQuery
 
->>> query = SQLQuery("employees", "SELECT dept, AVG(salary) FROM self GROUP BY dept")
+>>> query = SQLQuery(Table("employees"), "SELECT dept, AVG(salary) FROM self GROUP BY dept")
 >>> result = client.execute(query)
 ```
 

docs/docs/content/documentation/plugins/sql.md

@@ -272,17 +272,17 @@ from rayforce.plugins.sql import SQLQuery
 client = TCPClient(host="localhost", port=5000)
 
 # Execute SQL query on remote table
-query = SQLQuery("employees", "SELECT dept, AVG(salary) FROM self GROUP BY dept")
+query = SQLQuery(Table("employees"), "SELECT dept, AVG(salary) FROM self GROUP BY dept")
 result = client.execute(query)
 
 # All SQL operations are supported
-update_query = SQLQuery("employees", "UPDATE self SET salary = salary * 1.1 WHERE rating > 4")
+update_query = SQLQuery(Table("employees"), "UPDATE self SET salary = salary * 1.1 WHERE rating > 4")
 client.execute(update_query)
 
-insert_query = SQLQuery("employees", "INSERT INTO self (id, name) VALUES (100, 'New Hire')")
+insert_query = SQLQuery(Table("employees"), "INSERT INTO self (id, name) VALUES (100, 'New Hire')")
 client.execute(insert_query)
 
-upsert_query = SQLQuery("employees", """
+upsert_query = SQLQuery(Table("employees"), """
     INSERT INTO self (id, name, salary)
     VALUES (100, 'Updated', 75000)
     ON CONFLICT (id) DO UPDATE

rayforce/plugins/sql.py

@@ -482,21 +482,18 @@ def _infer_name(self, expr: ParsedExpr) -> str:
         return "expr"
 
 
-def sql_query(query: str, table: Table) -> Table:
+def sql_query(table: Table, query: str) -> Table:
     return SQLCompiler().compile(SQLParser().parse(query), table)
 
 
 class SQLQuery:
-    def __init__(self, table: str, query: str) -> None:
-        self.table_name = table
-        self.query_str = query
-        self._parsed = SQLParser().parse(query)
+    def __init__(self, table: Table, query: str) -> None:
+        self.table = table
+        self.parsed = SQLParser().parse(query)
 
     @property
     def ipc(self):
-        from rayforce.types.table import Table
-
-        return SQLIPCCompiler().compile(self._parsed, Table(self.table_name)).ipc
+        return SQLIPCCompiler().compile(self.parsed, self.table).ipc
 
 
 class SQLIPCCompiler(SQLCompiler):

rayforce/types/table.py

@@ -574,7 +574,7 @@ def pivot(
     def sql(self, query: str) -> Table:
         from rayforce.plugins.sql import sql_query
 
-        return sql_query(query, t.cast("Table", self))
+        return sql_query(t.cast("Table", self), query)
 
 
 class Table(

tests/network/tcp/test_query_objects.py

@@ -148,7 +148,7 @@ def test_sql_select_query_tcp(client):
     )
     table.save("employees")
 
-    query = SQLQuery("employees", "SELECT name, age FROM self WHERE age > 25")
+    query = SQLQuery(Table("employees"), "SELECT name, age FROM self WHERE age > 25")
     result = _capture_and_eval(client, query)
 
     assert isinstance(result, Table)
@@ -164,7 +164,7 @@ def test_sql_update_query_tcp(client):
     )
     table.save("employees")
 
-    query = SQLQuery("employees", "UPDATE self SET salary = 75000.0 WHERE id = 1")
+    query = SQLQuery(Table("employees"), "UPDATE self SET salary = 75000.0 WHERE id = 1")
     result = _capture_and_eval(client, query)
 
     assert isinstance(result, Symbol)
@@ -182,7 +182,7 @@ def test_sql_insert_query_tcp(client):
     )
     table.save("employees")
 
-    query = SQLQuery("employees", "INSERT INTO self (id, name) VALUES (2, 'bob')")
+    query = SQLQuery(Table("employees"), "INSERT INTO self (id, name) VALUES (2, 'bob')")
     result = _capture_and_eval(client, query)
 
     assert isinstance(result, Symbol)
@@ -202,7 +202,7 @@ def test_sql_upsert_query_tcp(client):
     table.save("employees")
 
     query = SQLQuery(
-        "employees",
+        Table("employees"),
         "INSERT INTO self (id, name) VALUES (1, 'alice_updated') ON CONFLICT (id) DO UPDATE",
     )
     result = _capture_and_eval(client, query)
@@ -223,7 +223,7 @@ def test_sql_complex_select_tcp(client):
     table.save("employees")
 
     query = SQLQuery(
-        "employees",
+        Table("employees"),
         "SELECT dept, AVG(salary) AS avg_salary FROM self GROUP BY dept",
     )
     result = _capture_and_eval(client, query)

tests/network/websocket/test_query_objects.py

@@ -353,7 +353,7 @@ async def test_sql_select_query_ws(ws_server):
     )
     table.save("employees")
 
-    query = SQLQuery("employees", "SELECT name, age FROM self WHERE age > 25")
+    query = SQLQuery(Table("employees"), "SELECT name, age FROM self WHERE age > 25")
     result = await connection.execute(query)
 
     assert isinstance(result, Table)
@@ -379,7 +379,7 @@ async def test_sql_update_query_ws(ws_server):
     )
     table.save("employees")
 
-    query = SQLQuery("employees", "UPDATE self SET salary = 75000.0 WHERE id = 1")
+    query = SQLQuery(Table("employees"), "UPDATE self SET salary = 75000.0 WHERE id = 1")
     result = await connection.execute(query)
 
     assert isinstance(result, Table)
@@ -402,7 +402,7 @@ async def test_sql_insert_query_ws(ws_server):
     )
     table.save("employees")
 
-    query = SQLQuery("employees", "INSERT INTO self (id, name) VALUES (2, 'bob')")
+    query = SQLQuery(Table("employees"), "INSERT INTO self (id, name) VALUES (2, 'bob')")
     result = await connection.execute(query)
 
     assert isinstance(result, Table)
@@ -429,7 +429,7 @@ async def test_sql_upsert_query_ws(ws_server):
 
     # Update existing row
     query = SQLQuery(
-        "employees",
+        Table("employees"),
         "INSERT INTO self (id, name) VALUES (1, 'alice_updated') ON CONFLICT (id) DO UPDATE",
     )
     result = await connection.execute(query)
@@ -456,7 +456,7 @@ async def test_sql_complex_select_ws(ws_server):
     table.save("employees")
 
     query = SQLQuery(
-        "employees",
+        Table("employees"),
         "SELECT dept, AVG(salary) AS avg_salary FROM self GROUP BY dept",
     )
     result = await connection.execute(query)

tests/plugins/test_sql.py

@@ -429,40 +429,39 @@ def test_in_combined_with_and(sqlglot, sample_table):
 def test_sql_query_ipc_select(sqlglot):
     from rayforce.plugins.sql import SQLQuery
 
-    query = SQLQuery("employees", "SELECT name, age FROM self WHERE age > 30")
+    query = SQLQuery(Table("employees"), "SELECT name, age FROM self WHERE age > 30")
     assert query.ipc is not None
 
 
 def test_sql_query_ipc_update(sqlglot):
     from rayforce.plugins.sql import SQLQuery
 
-    query = SQLQuery("employees", "UPDATE self SET salary = 100000.0 WHERE level = 'senior'")
+    query = SQLQuery(Table("employees"), "UPDATE self SET salary = 100000.0 WHERE level = 'senior'")
     assert query.ipc is not None
 
 
 def test_sql_query_ipc_insert(sqlglot):
     from rayforce.plugins.sql import SQLQuery
 
-    query = SQLQuery("employees", "INSERT INTO self (id, name) VALUES (1, 'Alice')")
+    query = SQLQuery(Table("employees"), "INSERT INTO self (id, name) VALUES (1, 'Alice')")
     assert query.ipc is not None
 
 
 def test_sql_query_ipc_upsert(sqlglot):
     from rayforce.plugins.sql import SQLQuery
 
     query = SQLQuery(
-        "employees", "INSERT INTO self (id, name) VALUES (1, 'Alice') ON CONFLICT (id) DO UPDATE"
+        Table("employees"),
+        "INSERT INTO self (id, name) VALUES (1, 'Alice') ON CONFLICT (id) DO UPDATE",
     )
     assert query.ipc is not None
 
 
 def test_sql_query_stores_parsed(sqlglot):
     from rayforce.plugins.sql import ParsedSelect, SQLQuery
 
-    query = SQLQuery("employees", "SELECT * FROM self")
-    assert isinstance(query._parsed, ParsedSelect)
-    assert query.table_name == "employees"
-    assert query.query_str == "SELECT * FROM self"
+    query = SQLQuery(Table("employees"), "SELECT * FROM self")
+    assert isinstance(query.parsed, ParsedSelect)
 
 
 def test_missing_sqlglot_raises(monkeypatch):