Struct ProcedureDefinition 

pub struct ProcedureDefinition {

    pub name: String,
    pub schema: Option<String>,
    pub is_function: bool,
    pub parameters: Vec<ProcedureParameter>,
    pub return_type: Option<String>,
    pub returns_set: bool,
    pub return_columns: Vec<ReturnColumn>,
    pub language: ProcedureLanguage,
    pub body: String,
    pub volatility: Volatility,
    pub security_definer: bool,
    pub cost: Option<i32>,
    pub rows: Option<i32>,
    pub parallel: ParallelSafety,
    pub or_replace: bool,
    pub comment: Option<String>,
    pub checksum: Option<String>,
    pub version: Option<i32>,
}

A stored procedure or function definition.

Fields

name: String

Procedure name.

schema: Option<String>

Schema/namespace.

is_function: bool

Whether this is a function (returns value) or procedure.

parameters: Vec<ProcedureParameter>

Parameters.

return_type: Option<String>

Return type (for functions).

returns_set: bool

Returns a set/table (SETOF, TABLE).

return_columns: Vec<ReturnColumn>

Table columns for table-returning functions.

language: ProcedureLanguage

Procedure language.

body: String

Procedure body.

volatility: Volatility

Volatility (VOLATILE, STABLE, IMMUTABLE).

security_definer: bool

Security definer (runs as owner vs caller).

cost: Option<i32>

Cost estimate.

rows: Option<i32>

Rows estimate (for set-returning functions).

parallel: ParallelSafety

Parallel safety.

or_replace: bool

Whether to replace if exists.

comment: Option<String>

Comment/description.

checksum: Option<String>

Checksum of the body for change detection.

version: Option<i32>

Version number for manual versioning.

Implementations

impl ProcedureDefinition

pub fn new(name: impl Into<String>) -> Self

Create a new procedure definition.

pub fn function(name: impl Into<String>) -> Self

Create a new function definition.

pub fn procedure(name: impl Into<String>) -> Self

Create a new stored procedure definition.

pub fn schema(self, schema: impl Into<String>) -> Self

Set the schema.

pub fn param( self, name: impl Into<String>, data_type: impl Into<String>, ) -> Self

Add a parameter.

pub fn out_param( self, name: impl Into<String>, data_type: impl Into<String>, ) -> Self

Add an OUT parameter.

pub fn inout_param( self, name: impl Into<String>, data_type: impl Into<String>, ) -> Self

Add an INOUT parameter.

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

Set return type.

pub fn returns_setof(self, return_type: impl Into<String>) -> Self

Set returns SETOF type.

pub fn returns_table(self, columns: Vec<ReturnColumn>) -> Self

Set returns TABLE.

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

Set the language.

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

Set the body.

pub fn volatility(self, volatility: Volatility) -> Self

Set volatility.

pub fn immutable(self) -> Self

Mark as IMMUTABLE.

pub fn stable(self) -> Self

Mark as STABLE.

pub fn security_definer(self) -> Self

Mark as security definer.

pub fn cost(self, cost: i32) -> Self

Set cost.

pub fn parallel(self, parallel: ParallelSafety) -> Self

Set parallel safety.

pub fn comment(self, comment: impl Into<String>) -> Self

Set comment.

pub fn qualified_name(&self) -> String

Get the fully qualified name.

pub fn has_changed(&self, other: &ProcedureDefinition) -> bool

Check if the procedure has changed compared to another.

Trait Implementations

impl Clone for ProcedureDefinition

fn clone(&self) -> ProcedureDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcedureDefinition

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

Formats the value using the given formatter.

impl Default for ProcedureDefinition

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProcedureDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProcedureDefinition

fn eq(&self, other: &ProcedureDefinition) -> 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 Serialize for ProcedureDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProcedureDefinition

impl StructuralPartialEq for ProcedureDefinition