Struct prql_compiler::sql::Options

pub struct Options {
    pub format: bool,
    pub dialect: Option<Dialect>,
    pub signature_comment: bool,
}

Compilation options for SQL backend of the compiler.

Fields

format: bool

Pass generated SQL string trough a formatter that splits it into multiple lines and prettifies indentation and spacing.

Defaults to true.

dialect: Option<Dialect>

Target dialect you want to compile for.

Because PRQL compiles to a subset of SQL, not all SQL features are required for PRQL. This means that generic dialect may work with most databases.

If something does not work in dialect you need, please report it at GitHub issues.

If None is used, sql_dialect flag from query definition is used. If it does not exist, Dialect::Generic is used.

signature_comment: bool

Emits the compiler signature as a comment after generated SQL

Defaults to true.

Implementations

impl Options

pub fn no_format(self) -> Self

pub fn no_signature(self) -> Self

pub fn with_dialect(self, dialect: Dialect) -> Self

pub fn some(self) -> Option<Self>

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Options

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.