Skip to content

Update run() method to execute() #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update run() method to execute() #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions doc/design/client_design_doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = ...
Expand Down