Struct ToSqlConfigEntity 

pub struct ToSqlConfigEntity<'a> {
    pub enabled: bool,
    pub content: Option<&'a str>,
}

Represents configuration options for tuning the SQL generator.

When an item that can be rendered to SQL has these options at hand, they should be respected. If an item does not have them, then it is not expected that the SQL generation for those items can be modified.

The default configuration has enabled set to true, which indicates that the default SQL generation behavior will be used.

When enabled is false, no SQL is generated for the item being configured.

Fields

enabled: bool

content: Option<&'a str>

Implementations

impl ToSqlConfigEntity<'_>

pub fn to_sql( &self, entity: &SqlGraphEntity<'_>, context: &PgrxSql<'_>, ) -> Option<Result<String>>

Given a SqlGraphEntity, this function converts it to SQL based on the current configuration.

If the config overrides the default behavior (i.e. using the ToSql trait), then Some(eyre::Result) is returned. If the config does not override the default behavior, then None is returned. This can be used to dispatch SQL generation in a single line, e.g.:

config.to_sql(entity, context).unwrap_or_else(|| entity.to_sql(context))?

Trait Implementations

impl<'a> Clone for ToSqlConfigEntity<'a>

fn clone(&self) -> ToSqlConfigEntity<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToSqlConfigEntity<'_>

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

Formats the value using the given formatter.

impl<'a> Default for ToSqlConfigEntity<'a>

fn default() -> ToSqlConfigEntity<'a>

Returns the “default value” for a type.

impl Hash for ToSqlConfigEntity<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ToSqlConfigEntity<'_>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ToSqlConfigEntity<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ToSqlConfigEntity<'_>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ToSqlConfigEntity<'_>