prql_compile: Compile a PRQL query into a SQL query

In prqlr: R Bindings for the 'prqlc' Rust Library

Compile a PRQL query into a SQL query

Description

Compile a PRQL query into a SQL query

Usage

prql_compile(
  prql_query,
  target = getOption("prqlr.target", default = NULL),
  ...,
  format = getOption("prqlr.format", default = TRUE),
  signature_comment = getOption("prqlr.signature_comment", default = TRUE),
  display = getOption("prqlr.display", default = "plain")
)

Arguments

prql_query	A character of PRQL query.
target	A character of the target name to use or NULL. If NULL, the target contained in the query will be used. All available target names can be listed with the prql_get_targets() function.
...	Ignored.
format	A logical flag (default: TRUE). Whether to format the SQL query.
signature_comment	a logical flag. (default: TRUE). Whether to add a signature comment to the output SQL query.
display	A character, one of "plain" (default) or "ansi_color". If "ansi_color", error will be displayed with ANSI color.

Value

A character of the compiled SQL query.

Examples

"from mtcars | filter cyl > 6 | select {cyl, mpg}" |>
  prql_compile()

"from mtcars | filter cyl > 6 | select {cyl, mpg}" |>
  prql_compile(format = FALSE, signature_comment = FALSE)

"
from mtcars
filter cyl > 6
select !{cyl}
" |>
  prql_compile("sql.duckdb") |>
  cat()

# If the `target` argument is `NULL` (default) or `"sql.any"`,
# the target specified in the header of the query will be used.
"
prql target:sql.duckdb

from mtcars
filter cyl > 6
select !{cyl}
" |>
  prql_compile() |>
  cat()

prqlr documentation built on April 12, 2025, 1:47 a.m.