Skip to content

Minor documentation and typing update. #64

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

Merged
alxmrs merged 1 commit into from
Jul 13, 2025
Merged

Minor documentation and typing update. #64

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ df = c.sql('''
# A table of the average temperature for each location across time.
df.to_pandas()

# Alternatively, you can just create the DataFrame from the Dataset:
df = qr.read_xarray(ds).to_pandas()
# Alternatively, you can just create the DataFrame from the RecordBatchReader:
df = qr.read_xarray(ds).read_pandas()
df.head()
```

Expand Down
2 changes: 1 addition & 1 deletion xarray_sql/df.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ def pivot(ds: xr.Dataset) -> pd.DataFrame:
return ds.to_dataframe().reset_index()


def read_xarray(ds: xr.Dataset, chunks: Chunks = None) -> ArrowStreamExportable:
def read_xarray(ds: xr.Dataset, chunks: Chunks = None) -> pa.RecordBatchReader:
"""Pivots an Xarray Dataset into a PyArrow Table, partitioned by chunks.

Args:
Expand Down