Skip to content

feat: .xlsx doc #11

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
merged 2 commits into from
Nov 8, 2022
Merged

feat: .xlsx doc #11

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ca2b4f
fear: .xlsx doc
togami2864 Nov 2, 2022
775aff9
chore: review
togami2864 Nov 4, 2022
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
1 change: 1 addition & 0 deletions src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [NDJSON](config/dataset-formats/ndjson.md)
- [Delta Lake](config/dataset-formats/delta.md)
- [Arrow](config/dataset-formats/arrow.md)
- [Xlsx](config/dataset-formats/xlsx.md)
- [Blob store](./config/blob-store.md)
- [Databases](./config/databases.md)
- [Postgres wire protocol](postgres.md)
Expand Down
23 changes: 23 additions & 0 deletions src/config/dataset-formats/xlsx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Xlsx(Microsoft Excel)

Thanks to [calamine](https://github.com/tafia/calamine) crate, ROAPI supports the `.xlsx` file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need this reference line here (could get stale at some point). Could you please remove?


To load the `.xlsx`, `sheet_name` needs to be specified in a config.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add:

"By default, most .xlsx files initially use Sheet1 as the sheet_name. Be sure to change this sheet_name as needed if your spreadsheet uses a different sheet_name."


Ex) Sheet1

![xlsx_sheet_name](../../images/xlsx_sheet_name.png)


```yaml
tables:
- name: "excel_table"
uri: "path/to/file.xlsx"
option:
format: "xlsx"
sheet_name: "Sheet1"
```



If no `sheet_name` is specified, ROAPI will throw the error.
Binary file added src/images/.DS_Store
View file
Open in desktop
Binary file not shown.
Binary file added src/images/xlsx_sheet_name.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.