Package 'prqlr'

Title: R Bindings for the 'prqlc' Rust Library
Description: Provides a function to convert 'PRQL' strings to 'SQL' strings. Combined with other R functions that take 'SQL' as an argument, 'PRQL' can be used on R.
Authors: Tatsuya Shima [aut, cre], Authors of the dependency Rust crates [aut] (see inst/AUTHORS file for details)
Maintainer: Tatsuya Shima <[email protected]>
License: MIT + file LICENSE
Version: 0.9.0
Built: 2024-10-31 22:14:40 UTC
Source: https://github.com/PRQL/prqlc-r

Help Index


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)
)

Arguments

prql_query

a PRQL query string.

target

a compile target name to use. If not specified (NULL), the target contained in the query will be used. All available target names can be listed with the prql_get_targets function.

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.

Value

a SQL query string

See Also

prql_get_targets

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()

Get available target names

Description

Get available target names for the target option of the prql_compile() function.

Usage

prql_get_targets()

Value

a character vector of target names.

Examples

prql_get_targets()

prqlc's version

Description

prqlc's version

Usage

prql_version()

Value

a numeric_version with the version of the built-in prqlc.

Examples

prql_version()