Struct Routine 

pub struct Routine {
    pub schema: CompactString,
    pub name: CompactString,
    pub description: Option<String>,
    pub params: SmallVec<[RoutineParam; 4]>,
    pub return_type: ReturnType,
    pub volatility: Volatility,
    pub is_variadic: bool,
    pub executable: bool,
}

PostgreSQL function or procedure

Represents a callable routine with its parameters and return type.

Fields

schema: CompactString

Schema name

name: CompactString

Function/procedure name

description: Option<String>

Description from pg_description

params: SmallVec<[RoutineParam; 4]>

Function parameters

return_type: ReturnType

Return type

volatility: Volatility

Volatility (immutable, stable, volatile)

is_variadic: bool

Whether the function has a variadic parameter

executable: bool

Whether EXECUTE is allowed (for current role)

Implementations

impl Routine

pub fn qi(&self) -> QualifiedIdentifier

Get the qualified identifier for this routine

pub fn returns_scalar(&self) -> bool

Check if function returns a scalar value

pub fn returns_set_of_scalar(&self) -> bool

Check if function returns a set of scalar values

pub fn returns_single(&self) -> bool

Check if function returns a single row (not a set)

pub fn returns_set(&self) -> bool

Check if function returns a set of rows

pub fn returns_composite(&self) -> bool

Check if function returns a composite type (table row)

pub fn table_name(&self) -> Option<&str>

Get the table name if function returns a composite type

pub fn table_qi(&self) -> Option<&QualifiedIdentifier>

Get the table QI if function returns a composite type

pub fn is_return_type_alias(&self) -> bool

Check if the return type is an alias (domain type)

pub fn required_params(&self) -> impl Iterator<Item = &RoutineParam>

Get required parameters (non-variadic, no default)

pub fn optional_params(&self) -> impl Iterator<Item = &RoutineParam>

Get optional parameters (has default)

pub fn variadic_param(&self) -> Option<&RoutineParam>

Get the variadic parameter if present

pub fn get_param(&self, name: &str) -> Option<&RoutineParam>

Get parameter by name

pub fn param_count(&self) -> usize

Count of all parameters

pub fn required_param_count(&self) -> usize

Count of required parameters

pub fn is_volatile(&self) -> bool

Check if this is a volatile function

pub fn is_stable(&self) -> bool

Check if this is a stable function

pub fn is_immutable(&self) -> bool

Check if this is an immutable function

Trait Implementations

impl Clone for Routine

fn clone(&self) -> Routine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Routine

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

Formats the value using the given formatter.