arrow.qmd

---
freeze: true
---

# Arrow {#sec-arrow}

```{r}
#| results: "asis"
#| echo: false
source("_common.R")
status("polishing")
```

## Introduction

CSV files are designed to be easily read by humans.
They're a good interchange format because they're very simple and they can be read by every tool under the sun.
But CSV files aren't very efficient: you have to do quite a lot of work to read the data into R.
In this chapter, you'll learn about a powerful alternative: the [parquet format](https://parquet.apache.org/), an open standards-based format widely used by big data systems.

We'll pair parquet files with [Apache Arrow](https://arrow.apache.org), a multi-language toolbox designed for efficient analysis and transport of large data sets.
We'll use Apache Arrow via the the [arrow package](https://arrow.apache.org/docs/r/), which provides a dplyr backend allowing you to analyze larger-than-memory datasets using familiar dplyr syntax.
As an additional benefit, arrow is extremely fast: you'll see some examples later in the chapter.

Both arrow and dbplyr provide dplyr backends, so you might wonder when to use each.
In many cases, the choice is made for you, as in the data is already in a database or in parquet files, and you'll want to work with it as is.
But if you're starting with your own data (perhaps CSV files), you can either load it into a database or convert it to parquet.
In general, it's hard to know what will work best, so in the early stages of your analysis we'd encourage you to try both and pick the one that works the best for you.

(A big thanks to Danielle Navarro who contributed the initial version of this chapter.)

### Prerequisites

In this chapter, we'll continue to use the tidyverse, particularly dplyr, but we'll pair it with the arrow package which is designed specifically for working with large data.

```{r setup}
#| message: false
#| warning: false
library(tidyverse)
library(arrow)
```

Later in the chapter, we'll also see some connections between arrow and duckdb, so we'll also need dbplyr and duckdb.

```{r}
library(dbplyr, warn.conflicts = FALSE)
library(duckdb)
```

## Getting the data

We begin by getting a dataset worthy of these tools: a data set of item checkouts from Seattle public libraries, available online at [data.seattle.gov/Community/Checkouts-by-Title/tmmm-ytt6](https://data.seattle.gov/Community/Checkouts-by-Title/tmmm-ytt6).
This dataset contains 41,389,465 rows that tell you how many times each book was checked out each month from April 2005 to October 2022.

The following code will get you a cached copy of the data.
The data is a 9GB CSV file, so it will take some time to download: simply getting the data is often the first challenge!

```{r}
#| eval: false
dir.create("data", showWarnings = FALSE)
url <- "https://r4ds.s3.us-west-2.amazonaws.com/seattle-library-checkouts.csv"

# Default timeout is 60s; bump it up to an hour
options(timeout = 60 * 60)
download.file(url, "data/seattle-library-checkouts.csv")
```

## Opening a dataset

Let's start by taking a look at the data.
At 9GB, this file is large enough that we probably don't want to load the whole thing into memory.
A good rule of thumb is that you usually want at least twice as much memory as the size of the data, and many laptops top out at 16 Gb.
This means we want to avoid `read_csv()` and instead use the `arrow::open_dataset()`:

```{r open-dataset}
# partial schema for ISBN column only
opts <- CsvConvertOptions$create(col_types = schema(ISBN = string()))

seattle_csv <- open_dataset(
  sources = "data/seattle-library-checkouts.csv", 
  format = "csv",
  convert_options = opts
)
```

(Here we've had to use some relatively advanced code to parse the ISBN variable correctly: this is because the first \~83,000 rows don't contain any data so arrow guesses the wrong types. The arrow team is aware of this problem and there will hopefully be a better approach by the time you read this chapter.)

What happens when this code is run?
`open_dataset()` will scan a few thousand rows to figure out the structure of the data set.
Then it records what it's found and stops; it will only read further rows as you specifically request them.
This metadata is what we see if we print `seattle_csv`:

```{r}
seattle_csv
```

The first line in the output tells you that `seattle_csv` is stored locally on-disk as a single CSV file; it will only be loaded into memory as needed.
The remainder of the output tells you the column type that arrow has imputed for each column.

We can see what's actually in with `glimpse()`.
This reveals that there are \~41 million rows and 12 columns, and shows us a few values.

```{r glimpse-data}
#| cache: true
seattle_csv |> glimpse()
```

We can start to use this dataset with dplyr verbs, using `collect()` to force arrow to perform the computation and return some data.
For example, this code tells us the total number of checkouts per year:

```{r}
#| cache: true
seattle_csv |> 
  count(CheckoutYear, wt = Checkouts) |> 
  arrange(CheckoutYear) |> 
  collect()
```

Thanks to arrow, this code will work regardless of how large the underlying dataset is.
But it's currently rather slow: on Hadley's computer, it took \~10s to run.
That's not terrible given how much data we have, but we can make it much faster by switching to a better format.

## The parquet format

To make this data easier to work with, lets switch to the parquet file format and split it up into multiple files.
The following sections will first introduce you to parquet and partitioning, and then apply what we learned to the Seattle library data.

### Advantages of parquet

Like CSV, parquet is used for rectangular data, but instead of being a text format that you can read with any file editor, it's a custom binary format designed specifically for the needs of big data.
This means that:

-   Parquet files are usually smaller the equivalent CSV file.
    Parquet relies on [efficient encodings](https://parquet.apache.org/docs/file-format/data-pages/encodings/) to keep file size down, and supports file compression.
    This helps make parquet files fast because there's less data to move from disk to memory.

-   Parquet files have a rich type system.
    As we talked about in @sec-col-types, a CSV file does not provide any information about column types.
    For example, a CSV reader has to guess whether `"08-10-2022"` should be parsed as a string or a date.
    In contrast, parquet files store data in a way that records the type along with the data.

-   Parquet files are "column-oriented".
    This means that they're organised column-by-column, much like R's data frame.
    This typically leads to better performance for data analysis tasks compared to CSV files, which are organised row-by-row.

-   Parquet files are "chunked", which makes it possible to work on different parts of the file at the same time, and, if you're lucky, to skip some chunks all together.

### Partitioning

As datasets get larger and larger, storing all the data in a single file gets increasingly painful and it's often useful to split large datasets across many files.
When this structuring is done intelligently, this strategy can lead to significant improvements in performance because many analyses will only require a subset of the files.

There are no hard and fast rules about how to partition your data set: the results will depend on your data, access patterns, and the systems that read the data.
You're likely to need to do some experimentation before you find the ideal partitioning for your situation.
As a rough guide, arrow suggests that you avoid files smaller than 20MB and larger than 2GB and avoid partitions that produce more than 10,000 files.
You should also try to partition by variables that you filter by; as you'll see shortly, that allows arrow to skip a lot of work by reading only the relevant files.

### Rewriting the Seattle library data

Let's apply these ideas to the Seattle library data to see how they play out in practice.
We're going to partition by `CheckoutYear`, since it's likely some analyses will only want to look at recent data and partitioning by year yields 18 chunks of a reasonable size.

To rewrite the data we define the partition using `dplyr::group_by()` and then save the partitions to a directory with `arrow::write_dataset()`.
`write_dataset()` has two important arguments: a directory where we'll create the files and the format we'll use.

```{r}
pq_path <- "data/seattle-library-checkouts"
```

```{r write-dataset}
#| eval: !expr "!file.exists(pq_path)"

seattle_csv |>
  group_by(CheckoutYear) |>
  write_dataset(path = pq_path, format = "parquet")
```

This takes about a minute to run; as we'll see shortly this is an initial investment that pays off by making future operations much much faster.

Let's take a look at what we just produced:

```{r show-parquet-files}
tibble(
  files = list.files(pq_path, recursive = TRUE),
  size_MB = file.size(file.path(pq_path, files)) / 1024^2
)
```

Our single 9GB CSV file has been rewritten into 18 parquet files.
The file names use a "self-describing" convention used by the [Apache Hive](https://hive.apache.org) project.
Hive-style partitions name folders with a "key=value" convention, so as you might guess, the `CheckoutYear=2005` directory contains all the data where `CheckoutYear` is 2005.
Each file is between 100 and 300 MB and the total size is now around 4 GB, a little over half the size of the original CSV file.
This is as we expect since parquet is a much more efficient format.

## Using dplyr with arrow

Now we've created these parquet files, we'll need to read them in again.
We use `open_dataset()` again, but this time we give it a directory:

```{r}
seattle_pq <- open_dataset(pq_path)
```

Now we can write our dplyr pipeline.
For example, we could count the total number of books checked out in each month for the last five years:

```{r books-by-year-query}
query <- seattle_pq |> 
  filter(CheckoutYear >= 2018, MaterialType == "BOOK") |>
  group_by(CheckoutYear, CheckoutMonth) |>
  summarize(TotalCheckouts = sum(Checkouts)) |>
  arrange(CheckoutYear, CheckoutMonth)
```

Writing dplyr code for arrow data is conceptually similar to dbplyr, @sec-import-databases: you write dplyr code, which is automatically transformed into a query that the Apache Arrow C++ library understands, which is then executed when you call `collect()`.
If we print out the `query` object we can see a little information about what we expect Arrow to return when the execution takes place:

```{r}
query
```

And we can get the results by calling `collect()`:

```{r books-by-year}
query |> collect()
```

Like dbplyr, arrow only understands some R expressions, so you may not be able to write exactly the same code you usually would.
However, the list of operations and functions supported is fairly extensive and continues to grow; find a complete list of currently supported functions in `?acero`.

### Performance {#sec-parquet-fast}

Let's take a quick look at the performance impact of switching from CSV to parquet.
First, let's time how long it takes to calculate the number of books checked out in each month of 2021, when the data is stored as a single large csv:

```{r dataset-performance-csv}
#| cache: true

seattle_csv |> 
  filter(CheckoutYear == 2021, MaterialType == "BOOK") |>
  group_by(CheckoutMonth) |>
  summarize(TotalCheckouts = sum(Checkouts)) |>
  arrange(desc(CheckoutMonth)) |>
  collect() |> 
  system.time()
```

Now let's use our new version of the data set in which the Seattle library checkout data has been partitioned into 18 smaller parquet files:

```{r dataset-performance-multiple-parquet}
#| cache: true

seattle_pq |> 
  filter(CheckoutYear == 2021, MaterialType == "BOOK") |>
  group_by(CheckoutMonth) |>
  summarize(TotalCheckouts = sum(Checkouts)) |>
  arrange(desc(CheckoutMonth)) |>
  collect() |> 
  system.time()
```

The \~100x speedup in performance is attributable to two factors: the multi-file partitioning, and the format of individual files:

-   Partitioning improves performance because this query uses `CheckoutYear == 2021` to filter the data, and arrow is smart enough to recognize that it only needs to read 1 of the 18 parquet files.
-   The parquet format improves performance by storing data in a binary format that can be read more directly into memory. The column-wise format and rich metadata means that arrow only needs to read the four columns actually used in the query (`CheckoutYear`, `MaterialType`, `CheckoutMonth`, and `Checkouts`).

This massive difference in performance is why it pays off to convert large CSVs to parquet!

### Using dbplyr with arrow

There's one last advantage of parquet and arrow --- it's very easy to turn an arrow dataset into a duckdb datasource by calling `arrow::to_duckdb()`:

```{r use-duckdb}
seattle_pq |> 
  to_duckdb() |>
  filter(CheckoutYear >= 2018, MaterialType == "BOOK") |>
  group_by(CheckoutYear) |>
  summarize(TotalCheckouts = sum(Checkouts)) |>
  arrange(desc(CheckoutYear)) |>
  collect()
```

The neat thing about `to_duckdb()` is that the transfer doesn't involve any memory copying, and speaks to the goals of the arrow ecosystem: enabling seamless transitions from one computing environment to another.

## Summary

In this chapter, you've been given a taste of the arrow package, which provides a dplyr backend for working with large on-disk datasets.
It can work with CSV files, its much much faster if you convert your data to parquet.
Parquet is a binary data format that's designed specifically for data analysis on modern computers.
Far fewer tools can work with parquet files compared to CSV, but it's partitioned, compressed, and columnar structure makes it much more efficient to analyze.

Next up you'll learn about your first non-rectangular data source, which you'll handle using tools provided by the tidyr package.
We'll focus on data that comes from JSON files, but the general principles apply to tree-like data regardless of its source.