Skip to content
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.

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

docs: missing to_parquet() docs #9600

Closed
1 task done
ncclementi opened this issue Jul 15, 2024 · 1 comment · Fixed by #9608
Closed
1 task done

docs: missing to_parquet() docs #9600

ncclementi opened this issue Jul 15, 2024 · 1 comment · Fixed by #9608
Labels
docs Documentation related issues or PRs

Comments

@ncclementi
Copy link
Contributor

Please describe the issue

xref zulip: https://ibis-project.zulipchat.com/#narrow/stream/405265-tech-support/topic/specify.20partition.20columns.20in.20to_parquet.28.29.3F/near/451643876

We have docstrings but I wasn't able to find this rendered, is this intentional because it's experimental or they are somehow missing?

"""Write the results of executing the given expression to a parquet file.
This method is eager and will execute the associated expression
immediately.
Parameters
----------
path
The data source. A string or Path to the parquet file.
params
Mapping of scalar parameter expressions to value.
**kwargs
Additional keyword arguments passed to pyarrow.parquet.ParquetWriter
https://arrow.apache.org/docs/python/generated/pyarrow.parquet.ParquetWriter.html
Examples
--------
Write out an expression to a single parquet file.
>>> import ibis
>>> import tempfile
>>> penguins = ibis.examples.penguins.fetch()
>>> penguins.to_parquet(tempfile.mktemp())
Partition on a single column.
>>> penguins.to_parquet(tempfile.mkdtemp(), partition_by="year")
Partition on multiple columns.
>>> penguins.to_parquet(tempfile.mkdtemp(), partition_by=("year", "island"))
::: {.callout-note}
## Hive-partitioned output is currently only supported when using DuckDB
:::
"""

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ncclementi ncclementi added the docs Documentation related issues or PRs label Jul 15, 2024
@gforsyth
Copy link
Member

so a bunch of these are rendered in the backend docs pages, but aren't showing up in Algolia. I'm going to try to add them to our additional algolia index scrape script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants