Azure / Azure/azure-kusto-python

API CHANGE: add `to_dataframe` to each table

Open
#126 2 comments 0 reactions 0 assignees View on GitHub
Discussion
Dominant language
Python
Stars
204
Forks
118
Avg merge
13d 7h
Merged PRs (30d)
1

Description

After investing work in https://github.com/Azure/azure-kusto-python/pull/124,
and some internal discussions, we agreed to wait with this PR and reconsider changing the API to give better performance for both vanilla python and pandas use cases, and save some difficult trickery to allow parsing kusto type to dataframe:

Final api would look like
```python
# result is of type KustoResultDataSet
result = client.execute(db, query)
# raw json
result.tables[0].json()
# iterator with lazy parsing of json
result.tables[0].rows()
# dataframe parsing from raw json
result.tables[0].to_dataframe()
```

This will cause some memory pressure, so a best practice would probably be:
```python
# either explicitly access a specific table and drop the reference after conversion
df = client.execute(db, query).primary_results[0].to_dataframe()
# or, parse it all
dfs = client.execute(db, query).to_dataframes()
```

Feel free to add your thoughts, code will be implemented in next couple of weeks.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.