Struct FunctionDef 

pub struct FunctionDef { /* private fields */ }

Function definition for CREATE FUNCTION

This struct represents a function definition, including its name, parameters, return type, language, behavior, security, and body.

Examples

use reinhardt_query::types::function::{FunctionDef, FunctionLanguage};

// CREATE FUNCTION my_func() RETURNS integer
let func = FunctionDef::new("my_func")
    .returns("integer")
    .language(FunctionLanguage::Sql)
    .body("SELECT 1");

Implementations

impl FunctionDef

pub fn new<N: IntoIden>(name: N) -> Self

Create a new function definition

Examples

use reinhardt_query::types::function::FunctionDef;

let func = FunctionDef::new("my_func");

pub fn or_replace(self, or_replace: bool) -> Self

Set OR REPLACE clause

Examples

use reinhardt_query::types::function::FunctionDef;

let func = FunctionDef::new("my_func")
    .or_replace(true);

pub fn add_parameter<N: IntoIden, T: Into<String>>( self, name: N, param_type: T, ) -> Self

Add a function parameter

Examples

use reinhardt_query::types::function::FunctionDef;

let func = FunctionDef::new("my_func")
    .add_parameter("param1", "integer")
    .add_parameter("param2", "text");

pub fn add_parameter_spec(self, param: FunctionParameter) -> Self

Add a function parameter with full specification

Examples

use reinhardt_query::types::function::{FunctionDef, FunctionParameter, ParameterMode};

let param = FunctionParameter::new()
    .name("my_param")
    .param_type("integer")
    .mode(ParameterMode::InOut);

let func = FunctionDef::new("my_func")
    .add_parameter_spec(param);

pub fn returns<T: Into<String>>(self, returns: T) -> Self

Set RETURNS type

Examples

use reinhardt_query::types::function::FunctionDef;

let func = FunctionDef::new("my_func")
    .returns("integer");

pub fn language(self, language: FunctionLanguage) -> Self

Set LANGUAGE

Examples

use reinhardt_query::types::function::{FunctionDef, FunctionLanguage};

let func = FunctionDef::new("my_func")
    .language(FunctionLanguage::PlPgSql);

pub fn behavior(self, behavior: FunctionBehavior) -> Self

Set function behavior (IMMUTABLE/STABLE/VOLATILE)

Examples

use reinhardt_query::types::function::{FunctionDef, FunctionBehavior};

let func = FunctionDef::new("my_func")
    .behavior(FunctionBehavior::Immutable);

pub fn security(self, security: FunctionSecurity) -> Self

Set security context (DEFINER/INVOKER)

Examples

use reinhardt_query::types::function::{FunctionDef, FunctionSecurity};

let func = FunctionDef::new("my_func")
    .security(FunctionSecurity::Definer);

pub fn body<B: Into<String>>(self, body: B) -> Self

Set function body (AS clause)

Examples

use reinhardt_query::types::function::FunctionDef;

let func = FunctionDef::new("my_func")
    .body("SELECT 1");

Trait Implementations

impl Clone for FunctionDef

fn clone(&self) -> FunctionDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDef

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

Formats the value using the given formatter.