File: show_exec_plan.Rd

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (31 lines) | stat: -rw-r--r-- 963 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dplyr.R
\name{show_exec_plan}
\alias{show_exec_plan}
\title{Show the details of an Arrow Execution Plan}
\usage{
show_exec_plan(x)
}
\arguments{
\item{x}{an \code{arrow_dplyr_query} to print the \code{ExecPlan} for.}
}
\value{
\code{x}, invisibly.
}
\description{
This is a function which gives more details about the logical query plan
that will be executed when evaluating an \code{arrow_dplyr_query} object.
It calls the C++ \code{ExecPlan} object's print method.
Functionally, it is similar to \code{dplyr::explain()}. This function is used as
the \code{dplyr::explain()} and \code{dplyr::show_query()} methods.
}
\examples{
\dontshow{if (arrow_with_dataset() && requireNamespace("dplyr", quietly = TRUE)) withAutoprint(\{ # examplesIf}
library(dplyr)
mtcars |>
  arrow_table() |>
  filter(mpg > 20) |>
  mutate(x = gear / carb) |>
  show_exec_plan()
\dontshow{\}) # examplesIf}
}