Skip to content

docs: correct Elixir CompileOptions.target docstring #6149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
max-sixty merged 3 commits into from
Aug 7, 2026
Merged

docs: correct Elixir CompileOptions.target docstring #6149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3eccdac
docs: correct Elixir CompileOptions.target docstring
prql-bot Aug 6, 2026
43b1738
docs: note target precedence in PRQL.compile/2 docs
prql-bot Aug 6, 2026
0fc538d
docs: note the `:generic` default on Elixir `target`
prql-bot Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion prqlc/bindings/elixir/lib/prql.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ defmodule PRQL do

* `:target` - Dialect used for generate SQL. Accepted values are
`:generic`, `:mssql`, `:mysql`, `:postgres`, `:ansi`, `:bigquery`,
`:clickhouse`, `:duckdb`, `:glaredb`, `:oracle`, `:redshift`, `:sqlite`, `:snowflake`
`:clickhouse`, `:duckdb`, `:glaredb`, `:oracle`, `:redshift`, `:sqlite`, `:snowflake`.
Defaults to `:generic`. The dialect given here always wins over a
`target:sql.…` argument in the query header; there is no value that defers
to the header.

* `:format` - Formats the output, defaults to `true`

Expand Down
7 changes: 5 additions & 2 deletions prqlc/bindings/elixir/native/prql/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,11 @@ pub struct CompileOptions {
/// If something does not work in a specific dialect, please raise in a
/// GitHub issue.
///
/// If `None` is used, the `target` argument from the query header is used.
/// If it does not exist, [`prqlc::sql::Dialect::Generic`] is used.
/// Defaults to `:generic`; an atom that names no known dialect also falls
/// back to [`prqlc::sql::Dialect::Generic`]. Note that the dialect named
/// here always wins over a `target:sql.…` argument in the query header —
/// unlike [`prqlc::Options::target`], there is no value that defers to the
/// header.
pub target: Atom,

/// Emits the compiler signature as a comment after generated SQL
Expand Down
Loading