Struct CreateFunctionStatement 

pub struct CreateFunctionStatement { /* private fields */ }

Available on crate feature database and non-WebAssembly only.

CREATE FUNCTION statement builder

This struct provides a fluent API for constructing CREATE FUNCTION queries.

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::function::{FunctionLanguage, FunctionBehavior};

// CREATE FUNCTION my_func() RETURNS integer LANGUAGE SQL AS 'SELECT 1'
let query = Query::create_function()
    .name("my_func")
    .returns("integer")
    .language(FunctionLanguage::Sql)
    .body("SELECT 1");

// CREATE OR REPLACE FUNCTION my_func(a integer) RETURNS integer
// LANGUAGE PLPGSQL IMMUTABLE AS 'BEGIN RETURN a + 1; END;'
let query = Query::create_function()
    .name("my_func")
    .or_replace()
    .add_parameter("a", "integer")
    .returns("integer")
    .language(FunctionLanguage::PlPgSql)
    .behavior(FunctionBehavior::Immutable)
    .body("BEGIN RETURN a + 1; END;");

Implementations

impl CreateFunctionStatement

pub fn new() -> CreateFunctionStatement

Create a new CREATE FUNCTION statement

Examples

use reinhardt_query::prelude::*;

let query = Query::create_function();

pub fn take(&mut self) -> CreateFunctionStatement

Take the ownership of data in the current CreateFunctionStatement

pub fn name<N>(&mut self, name: N) -> &mut CreateFunctionStatement

where N: IntoIden,

Set the function name

Examples

use reinhardt_query::prelude::*;

let query = Query::create_function()
    .name("my_func");

pub fn or_replace(&mut self) -> &mut CreateFunctionStatement

Add OR REPLACE clause

Examples

use reinhardt_query::prelude::*;

let query = Query::create_function()
    .name("my_func")
    .or_replace();

pub fn add_parameter<N, T>( &mut self, name: N, param_type: T, ) -> &mut CreateFunctionStatement

where N: IntoIden, T: Into<String>,

Add a function parameter

Examples

use reinhardt_query::prelude::*;

let query = Query::create_function()
    .name("my_func")
    .add_parameter("param1", "integer")
    .add_parameter("param2", "text");

pub fn returns<T>(&mut self, returns: T) -> &mut CreateFunctionStatement

where T: Into<String>,

Set RETURNS type

Examples

use reinhardt_query::prelude::*;

let query = Query::create_function()
    .name("my_func")
    .returns("integer");

pub fn language( &mut self, language: FunctionLanguage, ) -> &mut CreateFunctionStatement

Set LANGUAGE

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::function::FunctionLanguage;

let query = Query::create_function()
    .name("my_func")
    .language(FunctionLanguage::PlPgSql);

pub fn behavior( &mut self, behavior: FunctionBehavior, ) -> &mut CreateFunctionStatement

Set function behavior (IMMUTABLE/STABLE/VOLATILE)

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::function::FunctionBehavior;

let query = Query::create_function()
    .name("my_func")
    .behavior(FunctionBehavior::Immutable);

pub fn security( &mut self, security: FunctionSecurity, ) -> &mut CreateFunctionStatement

Set security context (DEFINER/INVOKER)

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::function::FunctionSecurity;

let query = Query::create_function()
    .name("my_func")
    .security(FunctionSecurity::Definer);

pub fn body<B>(&mut self, body: B) -> &mut CreateFunctionStatement

where B: Into<String>,

Set function body (AS clause)

Security Warning

The function body is embedded directly into the CREATE FUNCTION statement and will be stored in the database. DO NOT pass user input directly to this method, as it could lead to arbitrary code execution.

Only use with trusted, validated code.

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::function::{FunctionLanguage, FunctionBehavior};

// ✅ SAFE: Static code
let query = Query::create_function()
    .name("my_func")
    .returns("integer")
    .language(FunctionLanguage::Sql)
    .body("SELECT 1");

// ❌ UNSAFE: User input
// let query = Query::create_function()
//     .name("user_func")
//     .body(&user_code);

Trait Implementations

impl Clone for CreateFunctionStatement

fn clone(&self) -> CreateFunctionStatement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateFunctionStatement

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

Formats the value using the given formatter.

impl Default for CreateFunctionStatement

fn default() -> CreateFunctionStatement

Returns the “default value” for a type.

impl QueryStatementBuilder for CreateFunctionStatement

fn build_any( &self, query_builder: &(dyn QueryBuilderTrait + 'static), ) -> (String, Values)

Build SQL statement for a database backend and collect query parameters

fn to_string<T>(&self, query_builder: T) -> String

where T: QueryBuilderTrait,

Build SQL statement for a database backend and return SQL string with values inlined as SQL literals.

fn build<T>(&self, query_builder: T) -> (String, Values)

where T: QueryBuilderTrait,

Build SQL statement with parameter collection

impl QueryStatementWriter for CreateFunctionStatement