Struct Function 

pub struct Function {

    pub name: String,
    pub catalog_name: String,
    pub schema_name: String,
    pub full_name: String,
    pub data_type: String,
    pub full_data_type: String,
    pub input_params: Option<FunctionParameterInfos>,
    pub return_params: Option<String>,
    pub routine_body_language: Option<String>,
    pub routine_definition: Option<String>,
    pub routine_dependencies: Option<String>,
    pub parameter_style: i32,
    pub is_deterministic: bool,
    pub sql_data_access: i32,
    pub is_null_call: bool,
    pub security_type: i32,
    pub specific_name: Option<String>,
    pub routine_body: i32,
    pub comment: Option<String>,
    pub properties: HashMap<String, String>,
    pub owner: Option<String>,
    pub function_id: Option<String>,
    pub created_at: Option<i64>,
    pub created_by: Option<String>,
    pub updated_at: Option<i64>,
    pub updated_by: Option<String>,
}

A User-Defined Function (UDF) registered under a catalog + schema hierarchy.

Fields

name: String

Name of function, relative to parent schema.

catalog_name: String

Name of parent catalog.

schema_name: String

Name of parent schema.

full_name: String

The three-level (fully qualified) name of the function.

Format: catalog_name.schema_name.function_name

data_type: String

Full data type specification of the return type of the function.

full_data_type: String

Full data type specification as SQL/catalogString text.

input_params: Option<FunctionParameterInfos>

The array of function parameter infos.

return_params: Option<String>

The return type of the function in JSON format.

routine_body_language: Option<String>

The language of the function routine body.

routine_definition: Option<String>

Function body.

routine_dependencies: Option<String>

Function dependencies (in JSON form).

parameter_style: i32

The parameter-passing style.

is_deterministic: bool

Indicates whether the function is deterministic.

sql_data_access: i32

SQL data access information.

is_null_call: bool

Indicates whether the function is null-calling.

security_type: i32

The security type of the function.

specific_name: Option<String>

The type of the function (SCALAR or TABLE).

routine_body: i32

The routine body.

comment: Option<String>

User-provided free-form text description.

properties: HashMap<String, String>

A map of key-value properties attached to the securable.

owner: Option<String>

Username of current owner of the function.

function_id: Option<String>

Unique identifier for the function.

created_at: Option<i64>

Time at which this function was created, in epoch milliseconds.

created_by: Option<String>

Username of function creator.

updated_at: Option<i64>

Time at which this function was last updated, in epoch milliseconds.

updated_by: Option<String>

Username of user who last modified the function.

Implementations

impl Function

pub fn qualified_name(&self) -> String

Returns the fully-qualified dot-separated name computed from component fields.

impl Function

pub fn return_params(&self) -> &str

Returns the value of return_params, or the default value if return_params is unset.

pub fn routine_body_language(&self) -> &str

Returns the value of routine_body_language, or the default value if routine_body_language is unset.

pub fn routine_definition(&self) -> &str

Returns the value of routine_definition, or the default value if routine_definition is unset.

pub fn routine_dependencies(&self) -> &str

Returns the value of routine_dependencies, or the default value if routine_dependencies is unset.

pub fn parameter_style(&self) -> ParameterStyle

Returns the enum value of parameter_style, or the default if the field is set to an invalid enum value.

pub fn set_parameter_style(&mut self, value: ParameterStyle)

Sets parameter_style to the provided enum value.

pub fn sql_data_access(&self) -> SqlDataAccess

Returns the enum value of sql_data_access, or the default if the field is set to an invalid enum value.

pub fn set_sql_data_access(&mut self, value: SqlDataAccess)

Sets sql_data_access to the provided enum value.

pub fn security_type(&self) -> SecurityType

Returns the enum value of security_type, or the default if the field is set to an invalid enum value.

pub fn set_security_type(&mut self, value: SecurityType)

Sets security_type to the provided enum value.

pub fn specific_name(&self) -> &str

Returns the value of specific_name, or the default value if specific_name is unset.

pub fn routine_body(&self) -> RoutineBody

Returns the enum value of routine_body, or the default if the field is set to an invalid enum value.

pub fn set_routine_body(&mut self, value: RoutineBody)

Sets routine_body to the provided enum value.

pub fn comment(&self) -> &str

Returns the value of comment, or the default value if comment is unset.

pub fn owner(&self) -> &str

Returns the value of owner, or the default value if owner is unset.

pub fn function_id(&self) -> &str

Returns the value of function_id, or the default value if function_id is unset.

pub fn created_at(&self) -> i64

Returns the value of created_at, or the default value if created_at is unset.

pub fn created_by(&self) -> &str

Returns the value of created_by, or the default value if created_by is unset.

pub fn updated_at(&self) -> i64

Returns the value of updated_at, or the default value if updated_at is unset.

pub fn updated_by(&self) -> &str

Returns the value of updated_by, or the default value if updated_by is unset.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Function

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Function> for Resource

fn from(v: Function) -> Self

Converts to this type from the input type.

impl Message for Function

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Function

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

Equality operator ==.

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

Inequality operator !=.

impl ResourceExt for Function

fn resource_name(&self) -> ResourceName

Get the name of the resource

fn resource_ref(&self) -> ResourceRef

Get the reference for the resource

fn resource_ident(&self) -> ResourceIdent

Get the ident for the resource

impl Serialize for Function

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Function

impl TryFrom<Function> for Object

type Error = Error

The type returned in the event of a conversion error.

fn try_from(obj: Function) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Object<ObjectLabel>> for Function

type Error = Error

The type returned in the event of a conversion error.

fn try_from(object: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Resource> for Function

type Error = Error

The type returned in the event of a conversion error.

fn try_from(r: Resource) -> Result<Self, Self::Error>

Performs the conversion.