From 865c08c81d5999ef59170fd3798e20a51a6f96c6 Mon Sep 17 00:00:00 2001 From: Romain Rigaux Date: Thu, 7 Jan 2021 14:49:41 -0800 Subject: [PATCH] Update run() method to execute() --- doc/design/client_design_doc.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/design/client_design_doc.md b/doc/design/client_design_doc.md index eab3743..4b96248 100644 --- a/doc/design/client_design_doc.md +++ b/doc/design/client_design_doc.md @@ -3,23 +3,25 @@ ## Overview SQLFlow Client connects [sqlflowserver](https://github.com/sql-machine-learning/sqlflowserver). -It only one method `Run` which takes a SQL statement and returns a `RowSet` object. +It only one method `Execute` which takes a SQL statement and returns a `CompoundMessage` object. ## Example +``` +export SQLFLOW_DATASOURCE=hive://localhost:10000/ +``` + ```python import sqlflow client = sqlflow.Client(server_url='localhost:50051') # Query SQL -rowset = client.run('SELECT ... FROM ...') -for row in rowset: - print(row) # [1, 1] +compound_message = client.execute('SELECT ... FROM ...') # Execution SQL, prints # Query OK, ... row affected (... sec) -client.run('DELETE FROM ... WHERE ...') +client.execute('DELETE FROM ... WHERE ...') # ML SQL, prints # epoch = 0, loss = ...