Struct Function

pub struct Function {

    pub id: u32,
    pub schema_id: u32,
    pub database_id: u32,
    pub name: String,
    pub owner: u32,
    pub arg_names: Vec<String>,
    pub arg_types: Vec<DataType>,
    pub return_type: Option<DataType>,
    pub language: String,
    pub link: Option<String>,
    pub name_in_runtime: Option<String>,
    pub body: Option<String>,
    pub compressed_binary: Option<Vec<u8>>,
    pub always_retry_on_network_error: bool,
    pub runtime: Option<String>,
    pub is_async: Option<bool>,
    pub is_batched: Option<bool>,
    pub created_at_epoch: Option<u64>,
    pub created_at_cluster_version: Option<String>,
    pub kind: Option<Kind>,
}

Fields

id: u32

schema_id: u32

database_id: u32

name: String

owner: u32

arg_names: Vec<String>

arg_types: Vec<DataType>

return_type: Option<DataType>

language: String

link: Option<String>

name_in_runtime: Option<String>

The function name in the runtime / on the remote side that is bound to the UDF created in RisingWave.

body: Option<String>

The source code of the function.

compressed_binary: Option<Vec<u8>>

The zstd-compressed binary of the function.

always_retry_on_network_error: bool

runtime: Option<String>

The runtime selected when multiple runtimes are available for the language. Now is not used.

is_async: Option<bool>

additional options for javascript functions

is_batched: Option<bool>

created_at_epoch: Option<u64>

created_at_cluster_version: Option<String>

Cluster version (tracked by git commit) when created

kind: Option<Kind>

Implementations

impl Function

pub fn link(&self) -> &str

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

pub fn name_in_runtime(&self) -> &str

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

pub fn body(&self) -> &str

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

pub fn compressed_binary(&self) -> &[u8]

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

pub fn runtime(&self) -> &str

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

pub fn is_async(&self) -> bool

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

pub fn is_batched(&self) -> bool

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

pub fn created_at_epoch(&self) -> u64

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

pub fn created_at_cluster_version(&self) -> &str

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

impl Function

pub fn get_id(&self) -> u32

pub fn get_schema_id(&self) -> u32

pub fn get_database_id(&self) -> u32

pub fn get_name(&self) -> &String

pub fn get_owner(&self) -> u32

pub fn get_arg_names(&self) -> &Vec<String>

pub fn get_arg_types(&self) -> &Vec<DataType>

pub fn get_return_type(&self) -> Result<&DataType, PbFieldNotFound>

pub fn get_language(&self) -> &String

pub fn get_link(&self) -> Result<&String, PbFieldNotFound>

pub fn get_name_in_runtime(&self) -> Result<&String, PbFieldNotFound>

pub fn get_body(&self) -> Result<&String, PbFieldNotFound>

pub fn get_compressed_binary(&self) -> Result<&Vec<u8>, PbFieldNotFound>

pub fn get_always_retry_on_network_error(&self) -> bool

pub fn get_runtime(&self) -> Result<&String, PbFieldNotFound>

pub fn get_is_async(&self) -> Result<&bool, PbFieldNotFound>

pub fn get_is_batched(&self) -> Result<&bool, PbFieldNotFound>

pub fn get_created_at_epoch(&self) -> Result<&u64, PbFieldNotFound>

pub fn get_created_at_cluster_version(&self) -> Result<&String, PbFieldNotFound>

pub fn get_kind(&self) -> Result<&Kind, PbFieldNotFound>

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

const 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 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

Tests for self and other values to be equal, and is used by ==.

const 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 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