Struct TableFunction 

pub struct TableFunction {
    pub args: Vec<ExprImpl>,
    pub return_type: DataType,
    pub function_type: TableFunctionType,
    pub user_defined: Option<Arc<FunctionCatalog>>,
}

A table function takes a row as input and returns a table. It is also known as Set-Returning Function.

See also TableFunction trait in expr crate and ProjectSetSelectItem.

Fields

args: Vec<ExprImpl>

return_type: DataType

function_type: TableFunctionType

user_defined: Option<Arc<FunctionCatalog>>

Catalog of user defined table function.

Implementations

impl TableFunction

pub fn new(func_type: TableFunctionType, args: Vec<ExprImpl>) -> RwResult<Self>

Create a TableFunction expr with the return type inferred from func_type and types of inputs.

pub fn new_user_defined( catalog: Arc<FunctionCatalog>, args: Vec<ExprImpl>, ) -> Self

Create a user-defined TableFunction.

pub fn new_file_scan(args: Vec<ExprImpl>) -> RwResult<Self>

A special table function which would be transformed into LogicalFileScan by TableFunctionToFileScanRule in the optimizer. select * from file_scan(‘parquet’, ‘s3’, region, ak, sk, location)

fn handle_postgres_or_mysql_query_args( catalog_reader: &ArcRwLockReadGuard<RawRwLock, Catalog>, db_name: &str, schema_path: SchemaPath<'_>, args: Vec<ExprImpl>, expect_connector_name: &str, ) -> RwResult<Vec<ExprImpl>>

pub fn new_postgres_query( catalog_reader: &ArcRwLockReadGuard<RawRwLock, Catalog>, db_name: &str, schema_path: SchemaPath<'_>, args: Vec<ExprImpl>, ) -> RwResult<Self>

pub fn new_mysql_query( catalog_reader: &ArcRwLockReadGuard<RawRwLock, Catalog>, db_name: &str, schema_path: SchemaPath<'_>, args: Vec<ExprImpl>, ) -> RwResult<Self>

pub fn new_internal_backfill_progress() -> Self

This is a highly specific internal table function meant to scan and aggregate backfill_table_id, row_count for all MVs which are still being created.

pub fn new_internal_source_backfill_progress() -> Self

pub fn new_internal_get_channel_delta_stats(args: Vec<ExprImpl>) -> Self

pub fn to_protobuf(&self) -> PbTableFunction

pub fn to_protobuf_checked_pure(&self, retract: bool) -> Result<PbTableFunction>

Serialize the table function. Returns an error if this will result in an impure table function on a retract stream, which may lead to inconsistent results.

pub fn name(&self) -> String

Get the name of the table function.

pub fn rewrite(self, rewriter: &mut impl ExprRewriter) -> Self

Trait Implementations

impl Clone for TableFunction

fn clone(&self) -> TableFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableFunction

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

Formats the value using the given formatter.

impl Expr for TableFunction

fn return_type(&self) -> DataType

Get the return type of the expr

fn try_to_expr_proto(&self) -> Result<ExprNode, String>

Try to serialize the expression, returning an error if it’s impossible.

fn to_expr_proto(&self) -> ExprNode

Serialize the expression. Panic if it’s impossible.

fn to_expr_proto_checked_pure( &self, retract: bool, context: &str, ) -> Result<ExprNode>

where Self: Clone,

Serialize the expression. Returns an error if this will result in an impure expression on a retract stream, which may lead to inconsistent results.

impl From<TableFunction> for ExprImpl

fn from(o: TableFunction) -> ExprImpl

Converts to this type from the input type.

impl Hash for TableFunction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TableFunction

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

impl StructuralPartialEq for TableFunction