docs: add a example of reading hive-style partitioned parquet dataset

pola-rs · Oct 31, 2023 · dbe42ad · dbe42ad
1 parent 865387c
commit dbe42ad
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 3 deletions.
diff --git a/R/parquet.R b/R/parquet.R
@@ -15,8 +15,22 @@
 #' @return LazyFrame
 #' @name scan_parquet
 #' @rdname IO_scan_parquet
-#' @examples
-#' # TODO write parquet example
+#' @examplesIf requireNamespace("arrow", quietly = TRUE) & arrow::arrow_with_dataset() & arrow::arrow_with_parquet()
+#' temp_dir = tempfile()
+#' # Write a hive-style partitioned parquet dataset
+#' arrow::write_dataset(
+#'   mtcars,
+#'   temp_dir,
+#'   partitioning = c("cyl", "gear"),
+#'   format = "parquet",
+#'   hive_style = TRUE
+#' )
+#' list.files(temp_dir, recursive = TRUE)
+#'
+#' # Read the dataset
+#' pl$scan_parquet(
+#'   file.path(temp_dir, "**/*.parquet")
+#' )$collect()
 pl$scan_parquet = function(
     file, # : str | Path,
     n_rows = NULL, # : int | None = None,

diff --git a/man/IO_scan_parquet.Rd b/man/IO_scan_parquet.Rd