type
stringclasses
5 values
name
stringlengths
1
55
qualified_name
stringlengths
5
143
docstring
stringlengths
0
3.59k
filepath
stringclasses
180 values
is_public
bool
2 classes
is_private
bool
2 classes
line_start
float64
0
1.54k
line_end
float64
0
1.56k
annotation
stringclasses
8 values
returns
stringclasses
236 values
parameters
listlengths
0
74
parent_class
stringclasses
298 values
value
stringclasses
112 values
bases
listlengths
0
3
api_element_summary
stringlengths
199
23k
method
from_jinja_template
fenic.core._logical_plan.jinja_validation.VariableTree.from_jinja_template
Validate a Jinja template and extract its variable schema. Analyzes a Jinja template to determine what data structure it expects, including variable types (arrays, objects, booleans) and nested field requirements. Enforces security restrictions by only allowing safe template constructs. Args: template: A Jinja template string to validate and analyze. Example: "Hello {{ user.name }}! {% for item in products %}{{ item.price }}{% endfor %}" Returns: VariableTree: Tree structure describing required variables and their types. For the example above, this indicates: - user: object with 'name' field - products: array of objects with 'price' field Raises: ValidationError: If the template contains: - Invalid Jinja syntax - Unsupported constructs (complex expressions, dynamic indexing, etc.) - Inconsistent variable usage (e.g., using same variable as both array and object)
site-packages/fenic/core/_logical_plan/jinja_validation.py
true
false
144
184
null
VariableTree
[ "cls", "template" ]
VariableTree
null
null
Type: method Member Name: from_jinja_template Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree.from_jinja_template Docstring: Validate a Jinja template and extract its variable schema. Analyzes a Jinja template to determine what data structure it expects, including variable types (arrays, objects, booleans) and nested field requirements. Enforces security restrictions by only allowing safe template constructs. Args: template: A Jinja template string to validate and analyze. Example: "Hello {{ user.name }}! {% for item in products %}{{ item.price }}{% endfor %}" Returns: VariableTree: Tree structure describing required variables and their types. For the example above, this indicates: - user: object with 'name' field - products: array of objects with 'price' field Raises: ValidationError: If the template contains: - Invalid Jinja syntax - Unsupported constructs (complex expressions, dynamic indexing, etc.) - Inconsistent variable usage (e.g., using same variable as both array and object) Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "template"] Returns: VariableTree Parent Class: VariableTree
method
filter_used_expressions
fenic.core._logical_plan.jinja_validation.VariableTree.filter_used_expressions
Filters expressions to only those used in the template, validating all template variables are defined. Args: exprs: List of expression objects to filter Returns: List of expressions that are actually used in the template, in order of appearance Raises: ValidationError: If a template variable doesn't have a corresponding expression
site-packages/fenic/core/_logical_plan/jinja_validation.py
true
false
186
223
null
List[Union[ColumnExpr, AliasExpr]]
[ "self", "exprs" ]
VariableTree
null
null
Type: method Member Name: filter_used_expressions Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree.filter_used_expressions Docstring: Filters expressions to only those used in the template, validating all template variables are defined. Args: exprs: List of expression objects to filter Returns: List of expressions that are actually used in the template, in order of appearance Raises: ValidationError: If a template variable doesn't have a corresponding expression Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "exprs"] Returns: List[Union[ColumnExpr, AliasExpr]] Parent Class: VariableTree
method
validate_jinja_variable
fenic.core._logical_plan.jinja_validation.VariableTree.validate_jinja_variable
Recursively validates that the structure and type requirements of a Jinja template variable match the actual column schema. This ensures that: - For-loop variables are backed by ArrayType columns. - Struct field access is valid and only used on StructType columns. Args: variable_name: The name of the top-level variable used in the Jinja template. data_type: The corresponding DataType from the input schema. Raises: TypeMismatchError: If the variable's usage does not match its actual type. ValidationError: If a struct field is accessed that does not exist. InternalError: If an unexpected or invalid requirement is encountered.
site-packages/fenic/core/_logical_plan/jinja_validation.py
true
false
225
283
null
None
[ "self", "variable_name", "data_type" ]
VariableTree
null
null
Type: method Member Name: validate_jinja_variable Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree.validate_jinja_variable Docstring: Recursively validates that the structure and type requirements of a Jinja template variable match the actual column schema. This ensures that: - For-loop variables are backed by ArrayType columns. - Struct field access is valid and only used on StructType columns. Args: variable_name: The name of the top-level variable used in the Jinja template. data_type: The corresponding DataType from the input schema. Raises: TypeMismatchError: If the variable's usage does not match its actual type. ValidationError: If a struct field is accessed that does not exist. InternalError: If an unexpected or invalid requirement is encountered. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "variable_name", "data_type"] Returns: None Parent Class: VariableTree
method
_get_or_create_variable
fenic.core._logical_plan.jinja_validation.VariableTree._get_or_create_variable
Get or create a top-level variable node.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
286
290
null
VariableNode
[ "self", "name" ]
VariableTree
null
null
Type: method Member Name: _get_or_create_variable Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._get_or_create_variable Docstring: Get or create a top-level variable node. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "name"] Returns: VariableNode Parent Class: VariableTree
method
_parse_template
fenic.core._logical_plan.jinja_validation.VariableTree._parse_template
Parse template string into AST with parent references.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
297
307
null
nodes.Node
[ "template" ]
VariableTree
null
null
Type: method Member Name: _parse_template Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._parse_template Docstring: Parse template string into AST with parent references. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["template"] Returns: nodes.Node Parent Class: VariableTree
method
_validate_template
fenic.core._logical_plan.jinja_validation.VariableTree._validate_template
Validate that template only contains allowed, safe constructs.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
309
341
null
None
[ "ast" ]
VariableTree
null
null
Type: method Member Name: _validate_template Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._validate_template Docstring: Validate that template only contains allowed, safe constructs. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["ast"] Returns: None Parent Class: VariableTree
method
_collect_variable_accesses
fenic.core._logical_plan.jinja_validation.VariableTree._collect_variable_accesses
Collect all variable accesses with proper scoping resolution.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
346
350
null
List[ReferenceWithDeps]
[ "ast" ]
VariableTree
null
null
Type: method Member Name: _collect_variable_accesses Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._collect_variable_accesses Docstring: Collect all variable accesses with proper scoping resolution. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["ast"] Returns: List[ReferenceWithDeps] Parent Class: VariableTree
method
_traverse_and_collect
fenic.core._logical_plan.jinja_validation.VariableTree._traverse_and_collect
Traverse AST and collect variable accesses with resolved paths.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
352
369
null
List[ReferenceWithDeps]
[ "node", "scope", "control_context" ]
VariableTree
null
null
Type: method Member Name: _traverse_and_collect Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._traverse_and_collect Docstring: Traverse AST and collect variable accesses with resolved paths. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["node", "scope", "control_context"] Returns: List[ReferenceWithDeps] Parent Class: VariableTree
method
_handle_for_loop
fenic.core._logical_plan.jinja_validation.VariableTree._handle_for_loop
Handle for loop: record iteration and update scope.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
371
400
null
List[ReferenceWithDeps]
[ "node", "scope", "control_context", "line_no" ]
VariableTree
null
null
Type: method Member Name: _handle_for_loop Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._handle_for_loop Docstring: Handle for loop: record iteration and update scope. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["node", "scope", "control_context", "line_no"] Returns: List[ReferenceWithDeps] Parent Class: VariableTree
method
_handle_conditional
fenic.core._logical_plan.jinja_validation.VariableTree._handle_conditional
Handle if statement: record condition variable.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
402
418
null
List[ReferenceWithDeps]
[ "node", "scope", "control_context", "line_no" ]
VariableTree
null
null
Type: method Member Name: _handle_conditional Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._handle_conditional Docstring: Handle if statement: record condition variable. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["node", "scope", "control_context", "line_no"] Returns: List[ReferenceWithDeps] Parent Class: VariableTree
method
_handle_output
fenic.core._logical_plan.jinja_validation.VariableTree._handle_output
Handle output expressions: record variables being displayed.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
420
454
null
List[ReferenceWithDeps]
[ "node", "scope", "control_context", "line_no" ]
VariableTree
null
null
Type: method Member Name: _handle_output Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._handle_output Docstring: Handle output expressions: record variables being displayed. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["node", "scope", "control_context", "line_no"] Returns: List[ReferenceWithDeps] Parent Class: VariableTree
method
_extract_variable_path
fenic.core._logical_plan.jinja_validation.VariableTree._extract_variable_path
Extract variable path as list of keys/fields from AST node.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
460
493
null
Optional[List[str]]
[ "node", "scope" ]
VariableTree
null
null
Type: method Member Name: _extract_variable_path Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._extract_variable_path Docstring: Extract variable path as list of keys/fields from AST node. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["node", "scope"] Returns: Optional[List[str]] Parent Class: VariableTree
method
_resolve_variable_path
fenic.core._logical_plan.jinja_validation.VariableTree._resolve_variable_path
Resolve variable path using current loop scope.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
495
508
null
List[str]
[ "path", "scope" ]
VariableTree
null
null
Type: method Member Name: _resolve_variable_path Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._resolve_variable_path Docstring: Resolve variable path using current loop scope. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["path", "scope"] Returns: List[str] Parent Class: VariableTree
method
_extract_output_dependencies
fenic.core._logical_plan.jinja_validation.VariableTree._extract_output_dependencies
Remove all variables that are not required to evaluate the output.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
514
528
null
List[TemplateReference]
[ "all_accesses" ]
VariableTree
null
null
Type: method Member Name: _extract_output_dependencies Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._extract_output_dependencies Docstring: Remove all variables that are not required to evaluate the output. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["all_accesses"] Returns: List[TemplateReference] Parent Class: VariableTree
method
_build_schema_tree
fenic.core._logical_plan.jinja_validation.VariableTree._build_schema_tree
Build the final schema tree from filtered variable accesses.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
530
549
null
VariableTree
[ "cls", "accesses" ]
VariableTree
null
null
Type: method Member Name: _build_schema_tree Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._build_schema_tree Docstring: Build the final schema tree from filtered variable accesses. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["cls", "accesses"] Returns: VariableTree Parent Class: VariableTree
method
_add_path_to_tree
fenic.core._logical_plan.jinja_validation.VariableTree._add_path_to_tree
Add a resolved path to the schema tree with proper type requirements.
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
551
580
null
None
[ "tree", "path", "leaf_requirement", "line_no" ]
VariableTree
null
null
Type: method Member Name: _add_path_to_tree Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree._add_path_to_tree Docstring: Add a resolved path to the schema tree with proper type requirements. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["tree", "path", "leaf_requirement", "line_no"] Returns: None Parent Class: VariableTree
method
__init__
fenic.core._logical_plan.jinja_validation.VariableTree.__init__
null
site-packages/fenic/core/_logical_plan/jinja_validation.py
true
false
0
0
null
None
[ "self", "variables" ]
VariableTree
null
null
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "variables"] Returns: None Parent Class: VariableTree
function
_format_path
fenic.core._logical_plan.jinja_validation._format_path
null
site-packages/fenic/core/_logical_plan/jinja_validation.py
false
true
582
589
null
str
[ "path" ]
null
null
null
Type: function Member Name: _format_path Qualified Name: fenic.core._logical_plan.jinja_validation._format_path Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["path"] Returns: str Parent Class: none
module
optimizer
fenic.core._logical_plan.optimizer
Optimizer module for optimizing logical plans. This module contains the logic for optimizing logical query plans. These classes are not part of the public API and should not be used directly.
site-packages/fenic/core/_logical_plan/optimizer/__init__.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: optimizer Qualified Name: fenic.core._logical_plan.optimizer Docstring: Optimizer module for optimizing logical plans. This module contains the logic for optimizing logical query plans. These classes are not part of the public API and should not be used directly. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
all
fenic.core._logical_plan.optimizer.all
null
site-packages/fenic/core/_logical_plan/optimizer/__init__.py
true
false
26
33
null
null
null
null
['LogicalPlanOptimizerRule', 'MergeFiltersRule', 'NotFilterPushdownRule', 'SemanticFilterRewriteRule', 'OptimizationResult', 'LogicalPlanOptimizer']
null
Type: attribute Member Name: all Qualified Name: fenic.core._logical_plan.optimizer.all Docstring: none Value: ['LogicalPlanOptimizerRule', 'MergeFiltersRule', 'NotFilterPushdownRule', 'SemanticFilterRewriteRule', 'OptimizationResult', 'LogicalPlanOptimizer'] Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
module
semantic_filter_rewrite_rule
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule
null
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: semantic_filter_rewrite_rule Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
SemanticFilterRewriteRule
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule
Optimization rule to reorder filter predicates by evaluation cost to minimize expensive LLM calls. This rule decomposes `AND` conditions and reorders predicates so that cheaper ones run first. It ensures that standard (non-LLM) filters are applied before filters involving LLM function calls, which helps avoid unnecessary LLM evaluations on rows that would be filtered out anyway. Predicates are categorized into two groups: 1. **Standard predicates** ~ regular filter conditions with no LLM calls. 2. **Semantic predicates** ~ contain one or more LLM function calls, sorted by number of calls (least to most complex). `OR` expressions involving LLM calls are treated as atomic units and are not decomposed to short circuit evaluation. For example: (col_a > 10) AND (semantic.predicate("...{col_b}") OR semantic.predicate("...{col_c}")) In this case, `(col_a > 10)` is applied first, and the entire `OR` expression is evaluated as a single unit. Short circuiting `OR` conditions is more involved than `AND` due to limitations in Polars' evaluation model. Properly supporting them would require either: - Generating row-wise UDFs that respect conditional logic, (since case statements are evaluating sequentially) or - Decomposing filters into `UNION ALL` operations with intermediate result caching to avoid recomputation.
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
18
143
null
null
null
null
null
[ "LogicalPlanOptimizerRule" ]
Type: class Member Name: SemanticFilterRewriteRule Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule Docstring: Optimization rule to reorder filter predicates by evaluation cost to minimize expensive LLM calls. This rule decomposes `AND` conditions and reorders predicates so that cheaper ones run first. It ensures that standard (non-LLM) filters are applied before filters involving LLM function calls, which helps avoid unnecessary LLM evaluations on rows that would be filtered out anyway. Predicates are categorized into two groups: 1. **Standard predicates** ~ regular filter conditions with no LLM calls. 2. **Semantic predicates** ~ contain one or more LLM function calls, sorted by number of calls (least to most complex). `OR` expressions involving LLM calls are treated as atomic units and are not decomposed to short circuit evaluation. For example: (col_a > 10) AND (semantic.predicate("...{col_b}") OR semantic.predicate("...{col_c}")) In this case, `(col_a > 10)` is applied first, and the entire `OR` expression is evaluated as a single unit. Short circuiting `OR` conditions is more involved than `AND` due to limitations in Polars' evaluation model. Properly supporting them would require either: - Generating row-wise UDFs that respect conditional logic, (since case statements are evaluating sequentially) or - Decomposing filters into `UNION ALL` operations with intermediate result caching to avoid recomputation. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
apply
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.apply
null
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
42
43
null
OptimizationResult
[ "self", "logical_plan", "session_state" ]
SemanticFilterRewriteRule
null
null
Type: method Member Name: apply Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.apply Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "logical_plan", "session_state"] Returns: OptimizationResult Parent Class: SemanticFilterRewriteRule
method
optimize_node
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.optimize_node
null
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
45
62
null
OptimizationResult
[ "self", "node", "session_state" ]
SemanticFilterRewriteRule
null
null
Type: method Member Name: optimize_node Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.optimize_node Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "node", "session_state"] Returns: OptimizationResult Parent Class: SemanticFilterRewriteRule
method
optimize_filter
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.optimize_filter
null
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
64
94
null
OptimizationResult
[ "self", "node", "session_state" ]
SemanticFilterRewriteRule
null
null
Type: method Member Name: optimize_filter Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.optimize_filter Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "node", "session_state"] Returns: OptimizationResult Parent Class: SemanticFilterRewriteRule
method
partition_predicates
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.partition_predicates
null
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
99
118
null
Tuple[List[LogicalExpr], List[LogicalExpr]]
[ "self", "predicate" ]
SemanticFilterRewriteRule
null
null
Type: method Member Name: partition_predicates Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.partition_predicates Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "predicate"] Returns: Tuple[List[LogicalExpr], List[LogicalExpr]] Parent Class: SemanticFilterRewriteRule
method
_make_and_expr
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule._make_and_expr
Combine multiple predicates with AND operators.
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
false
true
120
131
null
LogicalExpr
[ "predicates" ]
SemanticFilterRewriteRule
null
null
Type: method Member Name: _make_and_expr Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule._make_and_expr Docstring: Combine multiple predicates with AND operators. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["predicates"] Returns: LogicalExpr Parent Class: SemanticFilterRewriteRule
method
count_semantic_predicate_expressions
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.count_semantic_predicate_expressions
Count the number of semantic predicate expressions in the expression tree.
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
133
139
null
int
[ "expr" ]
SemanticFilterRewriteRule
null
null
Type: method Member Name: count_semantic_predicate_expressions Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.count_semantic_predicate_expressions Docstring: Count the number of semantic predicate expressions in the expression tree. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["expr"] Returns: int Parent Class: SemanticFilterRewriteRule
method
is_and_expr
fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.is_and_expr
null
site-packages/fenic/core/_logical_plan/optimizer/semantic_filter_rewrite_rule.py
true
false
141
143
null
bool
[ "expr" ]
SemanticFilterRewriteRule
null
null
Type: method Member Name: is_and_expr Qualified Name: fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.is_and_expr Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["expr"] Returns: bool Parent Class: SemanticFilterRewriteRule
module
not_filter_pushdown_rule
fenic.core._logical_plan.optimizer.not_filter_pushdown_rule
null
site-packages/fenic/core/_logical_plan/optimizer/not_filter_pushdown_rule.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: not_filter_pushdown_rule Qualified Name: fenic.core._logical_plan.optimizer.not_filter_pushdown_rule Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
NotFilterPushdownRule
fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule
Optimization rule that selectively pushes NOT operators inward using De Morgan's laws. This transformation only applies optimizations that increase AND expressions: - NOT(A OR B) becomes NOT(A) AND NOT(B) - NOT(NOT(A)) becomes A The rule deliberately avoids converting NOT(A AND B) to OR expressions since our optimization pipeline is focused on maximizing and optimizing AND expressions. This rule should be applied before semantic predicate reordering to increase the number of AND expressions that can be effectively reordered.
site-packages/fenic/core/_logical_plan/optimizer/not_filter_pushdown_rule.py
true
false
16
114
null
null
null
null
null
[ "LogicalPlanOptimizerRule" ]
Type: class Member Name: NotFilterPushdownRule Qualified Name: fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule Docstring: Optimization rule that selectively pushes NOT operators inward using De Morgan's laws. This transformation only applies optimizations that increase AND expressions: - NOT(A OR B) becomes NOT(A) AND NOT(B) - NOT(NOT(A)) becomes A The rule deliberately avoids converting NOT(A AND B) to OR expressions since our optimization pipeline is focused on maximizing and optimizing AND expressions. This rule should be applied before semantic predicate reordering to increase the number of AND expressions that can be effectively reordered. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
apply
fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.apply
null
site-packages/fenic/core/_logical_plan/optimizer/not_filter_pushdown_rule.py
true
false
30
31
null
OptimizationResult
[ "self", "logical_plan", "session_state" ]
NotFilterPushdownRule
null
null
Type: method Member Name: apply Qualified Name: fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.apply Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "logical_plan", "session_state"] Returns: OptimizationResult Parent Class: NotFilterPushdownRule
method
optimize_node
fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.optimize_node
null
site-packages/fenic/core/_logical_plan/optimizer/not_filter_pushdown_rule.py
true
false
33
53
null
OptimizationResult
[ "self", "node", "session_state" ]
NotFilterPushdownRule
null
null
Type: method Member Name: optimize_node Qualified Name: fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.optimize_node Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "node", "session_state"] Returns: OptimizationResult Parent Class: NotFilterPushdownRule
method
optimize_filter
fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.optimize_filter
null
site-packages/fenic/core/_logical_plan/optimizer/not_filter_pushdown_rule.py
true
false
55
68
null
OptimizationResult
[ "self", "node", "session_state" ]
NotFilterPushdownRule
null
null
Type: method Member Name: optimize_filter Qualified Name: fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.optimize_filter Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "node", "session_state"] Returns: OptimizationResult Parent Class: NotFilterPushdownRule
method
push_not_inward
fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.push_not_inward
Recursively push NOT operators inward but only in ways that increase AND expressions. Specifically, converts NOT(OR) to AND but leaves NOT(AND) intact.
site-packages/fenic/core/_logical_plan/optimizer/not_filter_pushdown_rule.py
true
false
70
110
null
LogicalExpr
[ "self", "expr" ]
NotFilterPushdownRule
null
null
Type: method Member Name: push_not_inward Qualified Name: fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.push_not_inward Docstring: Recursively push NOT operators inward but only in ways that increase AND expressions. Specifically, converts NOT(OR) to AND but leaves NOT(AND) intact. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expr"] Returns: LogicalExpr Parent Class: NotFilterPushdownRule
method
is_or_expr
fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.is_or_expr
null
site-packages/fenic/core/_logical_plan/optimizer/not_filter_pushdown_rule.py
true
false
112
114
null
bool
[ "expr" ]
NotFilterPushdownRule
null
null
Type: method Member Name: is_or_expr Qualified Name: fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.is_or_expr Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["expr"] Returns: bool Parent Class: NotFilterPushdownRule
module
merge_filters_rule
fenic.core._logical_plan.optimizer.merge_filters_rule
null
site-packages/fenic/core/_logical_plan/optimizer/merge_filters_rule.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: merge_filters_rule Qualified Name: fenic.core._logical_plan.optimizer.merge_filters_rule Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
MergeFiltersRule
fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule
Optimization rule that merges consecutive filter operations into a single filter. This rule identifies consecutive filter operations and combines their predicates into a single filter operation so the combined predicates can be better optimized by SemanticPredicateReorderRule.
site-packages/fenic/core/_logical_plan/optimizer/merge_filters_rule.py
true
false
11
52
null
null
null
null
null
[ "LogicalPlanOptimizerRule" ]
Type: class Member Name: MergeFiltersRule Qualified Name: fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule Docstring: Optimization rule that merges consecutive filter operations into a single filter. This rule identifies consecutive filter operations and combines their predicates into a single filter operation so the combined predicates can be better optimized by SemanticPredicateReorderRule. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
apply
fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.apply
null
site-packages/fenic/core/_logical_plan/optimizer/merge_filters_rule.py
true
false
18
20
null
OptimizationResult
[ "self", "logical_plan", "session_state" ]
MergeFiltersRule
null
null
Type: method Member Name: apply Qualified Name: fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.apply Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "logical_plan", "session_state"] Returns: OptimizationResult Parent Class: MergeFiltersRule
method
optimize_node
fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.optimize_node
null
site-packages/fenic/core/_logical_plan/optimizer/merge_filters_rule.py
true
false
22
39
null
OptimizationResult
[ "self", "node", "session_state" ]
MergeFiltersRule
null
null
Type: method Member Name: optimize_node Qualified Name: fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.optimize_node Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "node", "session_state"] Returns: OptimizationResult Parent Class: MergeFiltersRule
method
merge_filter
fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.merge_filter
null
site-packages/fenic/core/_logical_plan/optimizer/merge_filters_rule.py
true
false
41
52
null
OptimizationResult
[ "self", "node", "session_state" ]
MergeFiltersRule
null
null
Type: method Member Name: merge_filter Qualified Name: fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.merge_filter Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "node", "session_state"] Returns: OptimizationResult Parent Class: MergeFiltersRule
module
base
fenic.core._logical_plan.optimizer.base
null
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: base Qualified Name: fenic.core._logical_plan.optimizer.base Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
OptimizationResult
fenic.core._logical_plan.optimizer.base.OptimizationResult
Holds the result of an optimization pass. Includes both the optimized plan and whether any changes were made.
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
9
17
null
null
null
null
null
[]
Type: class Member Name: OptimizationResult Qualified Name: fenic.core._logical_plan.optimizer.base.OptimizationResult Docstring: Holds the result of an optimization pass. Includes both the optimized plan and whether any changes were made. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.optimizer.base.OptimizationResult.__init__
null
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
0
0
null
None
[ "self", "plan", "was_modified" ]
OptimizationResult
null
null
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.optimizer.base.OptimizationResult.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan", "was_modified"] Returns: None Parent Class: OptimizationResult
class
LogicalPlanOptimizerRule
fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizerRule
null
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
20
32
null
null
null
null
null
[ "ABC" ]
Type: class Member Name: LogicalPlanOptimizerRule Qualified Name: fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizerRule Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
apply
fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizerRule.apply
Apply the optimization rule to the logical plan. Args: logical_plan: The logical plan to optimize session_state: The session state to use for the optimization Returns: OptimizationResult: The optimized plan and whether any changes were made
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
21
32
null
OptimizationResult
[ "self", "logical_plan", "session_state" ]
LogicalPlanOptimizerRule
null
null
Type: method Member Name: apply Qualified Name: fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizerRule.apply Docstring: Apply the optimization rule to the logical plan. Args: logical_plan: The logical plan to optimize session_state: The session state to use for the optimization Returns: OptimizationResult: The optimized plan and whether any changes were made Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "logical_plan", "session_state"] Returns: OptimizationResult Parent Class: LogicalPlanOptimizerRule
class
LogicalPlanOptimizer
fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizer
null
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
35
58
null
null
null
null
null
[]
Type: class Member Name: LogicalPlanOptimizer Qualified Name: fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizer Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizer.__init__
null
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
36
38
null
null
[ "self", "session_state", "rules" ]
LogicalPlanOptimizer
null
null
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizer.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "session_state", "rules"] Returns: none Parent Class: LogicalPlanOptimizer
method
optimize
fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizer.optimize
Optimize the logical plan using all rules. Args: logical_plan: The logical plan to optimize session_state: The session state to use for the optimization Returns: OptimizationResult: The optimized plan and whether any changes were made
site-packages/fenic/core/_logical_plan/optimizer/base.py
true
false
40
58
null
OptimizationResult
[ "self", "logical_plan" ]
LogicalPlanOptimizer
null
null
Type: method Member Name: optimize Qualified Name: fenic.core._logical_plan.optimizer.base.LogicalPlanOptimizer.optimize Docstring: Optimize the logical plan using all rules. Args: logical_plan: The logical plan to optimize session_state: The session state to use for the optimization Returns: OptimizationResult: The optimized plan and whether any changes were made Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "logical_plan"] Returns: OptimizationResult Parent Class: LogicalPlanOptimizer
module
plans
fenic.core._logical_plan.plans
Logical plan module for query representation. Note: These classes are not part of the public API and should not be used directly.
site-packages/fenic/core/_logical_plan/plans/__init__.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: plans Qualified Name: fenic.core._logical_plan.plans Docstring: Logical plan module for query representation. Note: These classes are not part of the public API and should not be used directly. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
__all__
fenic.core._logical_plan.plans.__all__
null
site-packages/fenic/core/_logical_plan/plans/__init__.py
false
false
34
59
null
null
null
null
['Aggregate', 'SemanticAggregate', 'SemanticCluster', 'CacheInfo', 'DocSource', 'LogicalPlan', 'Join', 'SemanticJoin', 'SemanticSimilarityJoin', 'FileSink', 'TableSink', 'FileSource', 'InMemorySource', 'TableSource', 'SQL', 'DropDuplicates', 'Explode', 'Filter', 'Limit', 'Projection', 'Sort', 'Union', 'Unnest', 'CentroidInfo']
null
Type: attribute Member Name: __all__ Qualified Name: fenic.core._logical_plan.plans.__all__ Docstring: none Value: ['Aggregate', 'SemanticAggregate', 'SemanticCluster', 'CacheInfo', 'DocSource', 'LogicalPlan', 'Join', 'SemanticJoin', 'SemanticSimilarityJoin', 'FileSink', 'TableSink', 'FileSource', 'InMemorySource', 'TableSource', 'SQL', 'DropDuplicates', 'Explode', 'Filter', 'Limit', 'Projection', 'Sort', 'Union', 'Unnest', 'CentroidInfo'] Annotation: none is Public? : false is Private? : false Parameters: none Returns: none Parent Class: none
module
aggregate
fenic.core._logical_plan.plans.aggregate
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: aggregate Qualified Name: fenic.core._logical_plan.plans.aggregate Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
Aggregate
fenic.core._logical_plan.plans.aggregate.Aggregate
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
18
108
null
null
null
null
null
[ "LogicalPlan" ]
Type: class Member Name: Aggregate Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.plans.aggregate.Aggregate.__init__
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
19
34
null
null
[ "self", "input", "group_exprs", "agg_exprs", "session_state", "schema" ]
Aggregate
null
null
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "input", "group_exprs", "agg_exprs", "session_state", "schema"] Returns: none Parent Class: Aggregate
method
from_session_state
fenic.core._logical_plan.plans.aggregate.Aggregate.from_session_state
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
36
44
null
Aggregate
[ "cls", "input", "group_exprs", "agg_exprs", "session_state" ]
Aggregate
null
null
Type: method Member Name: from_session_state Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.from_session_state Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "input", "group_exprs", "agg_exprs", "session_state"] Returns: Aggregate Parent Class: Aggregate
method
from_schema
fenic.core._logical_plan.plans.aggregate.Aggregate.from_schema
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
46
54
null
Aggregate
[ "cls", "input", "group_exprs", "agg_exprs", "schema" ]
Aggregate
null
null
Type: method Member Name: from_schema Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.from_schema Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "input", "group_exprs", "agg_exprs", "schema"] Returns: Aggregate Parent Class: Aggregate
method
children
fenic.core._logical_plan.plans.aggregate.Aggregate.children
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
56
57
null
List[LogicalPlan]
[ "self" ]
Aggregate
null
null
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalPlan] Parent Class: Aggregate
method
_build_schema
fenic.core._logical_plan.plans.aggregate.Aggregate._build_schema
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
false
true
59
77
null
Schema
[ "self", "session_state" ]
Aggregate
null
null
Type: method Member Name: _build_schema Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate._build_schema Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "session_state"] Returns: Schema Parent Class: Aggregate
method
_repr
fenic.core._logical_plan.plans.aggregate.Aggregate._repr
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
false
true
79
80
null
str
[ "self" ]
Aggregate
null
null
Type: method Member Name: _repr Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate._repr Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self"] Returns: str Parent Class: Aggregate
method
group_exprs
fenic.core._logical_plan.plans.aggregate.Aggregate.group_exprs
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
82
83
null
List[LogicalExpr]
[ "self" ]
Aggregate
null
null
Type: method Member Name: group_exprs Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.group_exprs Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: Aggregate
method
agg_exprs
fenic.core._logical_plan.plans.aggregate.Aggregate.agg_exprs
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
85
86
null
List[LogicalExpr]
[ "self" ]
Aggregate
null
null
Type: method Member Name: agg_exprs Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.agg_exprs Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: Aggregate
method
exprs
fenic.core._logical_plan.plans.aggregate.Aggregate.exprs
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
88
91
null
List[LogicalExpr]
[ "self" ]
Aggregate
null
null
Type: method Member Name: exprs Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.exprs Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: Aggregate
method
with_children
fenic.core._logical_plan.plans.aggregate.Aggregate.with_children
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
true
false
93
98
null
LogicalPlan
[ "self", "children", "session_state" ]
Aggregate
null
null
Type: method Member Name: with_children Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate.with_children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "children", "session_state"] Returns: LogicalPlan Parent Class: Aggregate
method
_eq_specific
fenic.core._logical_plan.plans.aggregate.Aggregate._eq_specific
null
site-packages/fenic/core/_logical_plan/plans/aggregate.py
false
true
100
108
null
bool
[ "self", "other" ]
Aggregate
null
null
Type: method Member Name: _eq_specific Qualified Name: fenic.core._logical_plan.plans.aggregate.Aggregate._eq_specific Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "other"] Returns: bool Parent Class: Aggregate
function
_validate_groupby_expr
fenic.core._logical_plan.plans.aggregate._validate_groupby_expr
Validate groupby expressions.
site-packages/fenic/core/_logical_plan/plans/aggregate.py
false
true
110
121
null
null
[ "expr" ]
null
null
null
Type: function Member Name: _validate_groupby_expr Qualified Name: fenic.core._logical_plan.plans.aggregate._validate_groupby_expr Docstring: Validate groupby expressions. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["expr"] Returns: none Parent Class: none
module
sink
fenic.core._logical_plan.plans.sink
null
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: sink Qualified Name: fenic.core._logical_plan.plans.sink Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
FileSink
fenic.core._logical_plan.plans.sink.FileSink
Logical plan node that represents a file writing operation.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
14
117
null
null
null
null
null
[ "LogicalPlan" ]
Type: class Member Name: FileSink Qualified Name: fenic.core._logical_plan.plans.sink.FileSink Docstring: Logical plan node that represents a file writing operation. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.plans.sink.FileSink.__init__
Initialize a file sink node. Args: child: The logical plan that produces data to be written sink_type: The type of file sink (CSV, Parquet) path: File path to write to mode: Write mode - "error" or "overwrite". Default: "overwrite" - error: Raises an error if file exists - overwrite: Overwrites the file if it exists - ignore: Silently ignores operation if file exists session_state: The session state to use for the new node. schema: The schema to use for the new node.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
17
42
null
null
[ "self", "child", "sink_type", "path", "mode", "session_state", "schema" ]
FileSink
null
null
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.plans.sink.FileSink.__init__ Docstring: Initialize a file sink node. Args: child: The logical plan that produces data to be written sink_type: The type of file sink (CSV, Parquet) path: File path to write to mode: Write mode - "error" or "overwrite". Default: "overwrite" - error: Raises an error if file exists - overwrite: Overwrites the file if it exists - ignore: Silently ignores operation if file exists session_state: The session state to use for the new node. schema: The schema to use for the new node. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "child", "sink_type", "path", "mode", "session_state", "schema"] Returns: none Parent Class: FileSink
method
from_session_state
fenic.core._logical_plan.plans.sink.FileSink.from_session_state
null
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
44
53
null
FileSink
[ "cls", "child", "sink_type", "path", "mode", "session_state" ]
FileSink
null
null
Type: method Member Name: from_session_state Qualified Name: fenic.core._logical_plan.plans.sink.FileSink.from_session_state Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "child", "sink_type", "path", "mode", "session_state"] Returns: FileSink Parent Class: FileSink
method
from_schema
fenic.core._logical_plan.plans.sink.FileSink.from_schema
null
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
55
64
null
FileSink
[ "cls", "child", "sink_type", "path", "mode", "schema" ]
FileSink
null
null
Type: method Member Name: from_schema Qualified Name: fenic.core._logical_plan.plans.sink.FileSink.from_schema Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "child", "sink_type", "path", "mode", "schema"] Returns: FileSink Parent Class: FileSink
method
children
fenic.core._logical_plan.plans.sink.FileSink.children
Returns the child node of this sink operator.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
66
68
null
List[LogicalPlan]
[ "self" ]
FileSink
null
null
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.plans.sink.FileSink.children Docstring: Returns the child node of this sink operator. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalPlan] Parent Class: FileSink
method
exprs
fenic.core._logical_plan.plans.sink.FileSink.exprs
null
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
70
71
null
List[LogicalExpr]
[ "self" ]
FileSink
null
null
Type: method Member Name: exprs Qualified Name: fenic.core._logical_plan.plans.sink.FileSink.exprs Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: FileSink
method
_build_schema
fenic.core._logical_plan.plans.sink.FileSink._build_schema
The schema of a sink node is the same as its child's schema.
site-packages/fenic/core/_logical_plan/plans/sink.py
false
true
73
75
null
Schema
[ "self", "session_state" ]
FileSink
null
null
Type: method Member Name: _build_schema Qualified Name: fenic.core._logical_plan.plans.sink.FileSink._build_schema Docstring: The schema of a sink node is the same as its child's schema. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "session_state"] Returns: Schema Parent Class: FileSink
method
_repr
fenic.core._logical_plan.plans.sink.FileSink._repr
Return the string representation for this file sink plan.
site-packages/fenic/core/_logical_plan/plans/sink.py
false
true
77
81
null
str
[ "self" ]
FileSink
null
null
Type: method Member Name: _repr Qualified Name: fenic.core._logical_plan.plans.sink.FileSink._repr Docstring: Return the string representation for this file sink plan. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self"] Returns: str Parent Class: FileSink
method
with_children
fenic.core._logical_plan.plans.sink.FileSink.with_children
Create a new file sink with the same properties but different children. Args: children: The new children for this node. Must contain exactly one child. session_state: The session state to use for the new node. Returns: A new FileSink instance with the updated child. Raises: ValueError: If children doesn't contain exactly one LogicalPlan.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
83
110
null
LogicalPlan
[ "self", "children", "session_state" ]
FileSink
null
null
Type: method Member Name: with_children Qualified Name: fenic.core._logical_plan.plans.sink.FileSink.with_children Docstring: Create a new file sink with the same properties but different children. Args: children: The new children for this node. Must contain exactly one child. session_state: The session state to use for the new node. Returns: A new FileSink instance with the updated child. Raises: ValueError: If children doesn't contain exactly one LogicalPlan. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "children", "session_state"] Returns: LogicalPlan Parent Class: FileSink
method
_eq_specific
fenic.core._logical_plan.plans.sink.FileSink._eq_specific
null
site-packages/fenic/core/_logical_plan/plans/sink.py
false
true
112
117
null
bool
[ "self", "other" ]
FileSink
null
null
Type: method Member Name: _eq_specific Qualified Name: fenic.core._logical_plan.plans.sink.FileSink._eq_specific Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "other"] Returns: bool Parent Class: FileSink
class
TableSink
fenic.core._logical_plan.plans.sink.TableSink
Logical plan node that represents a table writing operation.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
119
215
null
null
null
null
null
[ "LogicalPlan" ]
Type: class Member Name: TableSink Qualified Name: fenic.core._logical_plan.plans.sink.TableSink Docstring: Logical plan node that represents a table writing operation. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.plans.sink.TableSink.__init__
Initialize a table sink node. Args: child: The logical plan that produces data to be written table_name: Name of the table to write to mode: Write mode. Default: "error" - error: Raises an error if table exists - append: Appends data to table if it exists - overwrite: Overwrites existing table - ignore: Silently ignores operation if table exists session_state: The session state to use for the new node. schema: The schema to use for the new node.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
122
146
null
null
[ "self", "child", "table_name", "mode", "session_state", "schema" ]
TableSink
null
null
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.plans.sink.TableSink.__init__ Docstring: Initialize a table sink node. Args: child: The logical plan that produces data to be written table_name: Name of the table to write to mode: Write mode. Default: "error" - error: Raises an error if table exists - append: Appends data to table if it exists - overwrite: Overwrites existing table - ignore: Silently ignores operation if table exists session_state: The session state to use for the new node. schema: The schema to use for the new node. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "child", "table_name", "mode", "session_state", "schema"] Returns: none Parent Class: TableSink
method
from_session_state
fenic.core._logical_plan.plans.sink.TableSink.from_session_state
null
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
148
156
null
TableSink
[ "cls", "child", "table_name", "mode", "session_state" ]
TableSink
null
null
Type: method Member Name: from_session_state Qualified Name: fenic.core._logical_plan.plans.sink.TableSink.from_session_state Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "child", "table_name", "mode", "session_state"] Returns: TableSink Parent Class: TableSink
method
from_schema
fenic.core._logical_plan.plans.sink.TableSink.from_schema
null
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
158
166
null
TableSink
[ "cls", "child", "table_name", "mode", "schema" ]
TableSink
null
null
Type: method Member Name: from_schema Qualified Name: fenic.core._logical_plan.plans.sink.TableSink.from_schema Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "child", "table_name", "mode", "schema"] Returns: TableSink Parent Class: TableSink
method
children
fenic.core._logical_plan.plans.sink.TableSink.children
Returns the child node of this sink operator.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
168
170
null
List[LogicalPlan]
[ "self" ]
TableSink
null
null
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.plans.sink.TableSink.children Docstring: Returns the child node of this sink operator. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalPlan] Parent Class: TableSink
method
exprs
fenic.core._logical_plan.plans.sink.TableSink.exprs
null
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
172
173
null
List[LogicalExpr]
[ "self" ]
TableSink
null
null
Type: method Member Name: exprs Qualified Name: fenic.core._logical_plan.plans.sink.TableSink.exprs Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: TableSink
method
_build_schema
fenic.core._logical_plan.plans.sink.TableSink._build_schema
The schema of a sink node is the same as its child's schema.
site-packages/fenic/core/_logical_plan/plans/sink.py
false
true
175
177
null
Schema
[ "self", "session_state" ]
TableSink
null
null
Type: method Member Name: _build_schema Qualified Name: fenic.core._logical_plan.plans.sink.TableSink._build_schema Docstring: The schema of a sink node is the same as its child's schema. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "session_state"] Returns: Schema Parent Class: TableSink
method
_repr
fenic.core._logical_plan.plans.sink.TableSink._repr
Return the string representation for this table sink plan.
site-packages/fenic/core/_logical_plan/plans/sink.py
false
true
179
181
null
str
[ "self" ]
TableSink
null
null
Type: method Member Name: _repr Qualified Name: fenic.core._logical_plan.plans.sink.TableSink._repr Docstring: Return the string representation for this table sink plan. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self"] Returns: str Parent Class: TableSink
method
with_children
fenic.core._logical_plan.plans.sink.TableSink.with_children
Create a new table sink with the same properties but different children. Args: children: The new children for this node. Must contain exactly one child. session_state: The session state to use for the new node. Returns: A new TableSink instance with the updated child. Raises: ValueError: If children doesn't contain exactly one LogicalPlan.
site-packages/fenic/core/_logical_plan/plans/sink.py
true
false
183
209
null
LogicalPlan
[ "self", "children", "session_state" ]
TableSink
null
null
Type: method Member Name: with_children Qualified Name: fenic.core._logical_plan.plans.sink.TableSink.with_children Docstring: Create a new table sink with the same properties but different children. Args: children: The new children for this node. Must contain exactly one child. session_state: The session state to use for the new node. Returns: A new TableSink instance with the updated child. Raises: ValueError: If children doesn't contain exactly one LogicalPlan. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "children", "session_state"] Returns: LogicalPlan Parent Class: TableSink
method
_eq_specific
fenic.core._logical_plan.plans.sink.TableSink._eq_specific
null
site-packages/fenic/core/_logical_plan/plans/sink.py
false
true
211
215
null
bool
[ "self", "other" ]
TableSink
null
null
Type: method Member Name: _eq_specific Qualified Name: fenic.core._logical_plan.plans.sink.TableSink._eq_specific Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "other"] Returns: bool Parent Class: TableSink
module
join
fenic.core._logical_plan.plans.join
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: join Qualified Name: fenic.core._logical_plan.plans.join Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
Join
fenic.core._logical_plan.plans.join.Join
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
30
150
null
null
null
null
null
[ "LogicalPlan" ]
Type: class Member Name: Join Qualified Name: fenic.core._logical_plan.plans.join.Join Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.plans.join.Join.__init__
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
31
49
null
null
[ "self", "left", "right", "left_on", "right_on", "how", "session_state", "schema" ]
Join
null
null
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.plans.join.Join.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "left", "right", "left_on", "right_on", "how", "session_state", "schema"] Returns: none Parent Class: Join
method
from_session_state
fenic.core._logical_plan.plans.join.Join.from_session_state
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
51
59
null
Join
[ "cls", "left", "right", "left_on", "right_on", "how", "session_state" ]
Join
null
null
Type: method Member Name: from_session_state Qualified Name: fenic.core._logical_plan.plans.join.Join.from_session_state Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "left", "right", "left_on", "right_on", "how", "session_state"] Returns: Join Parent Class: Join
method
from_schema
fenic.core._logical_plan.plans.join.Join.from_schema
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
61
69
null
Join
[ "cls", "left", "right", "left_on", "right_on", "how", "schema" ]
Join
null
null
Type: method Member Name: from_schema Qualified Name: fenic.core._logical_plan.plans.join.Join.from_schema Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "left", "right", "left_on", "right_on", "how", "schema"] Returns: Join Parent Class: Join
method
children
fenic.core._logical_plan.plans.join.Join.children
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
71
72
null
List[LogicalPlan]
[ "self" ]
Join
null
null
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.plans.join.Join.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalPlan] Parent Class: Join
method
exprs
fenic.core._logical_plan.plans.join.Join.exprs
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
74
75
null
List[LogicalExpr]
[ "self" ]
Join
null
null
Type: method Member Name: exprs Qualified Name: fenic.core._logical_plan.plans.join.Join.exprs Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: Join
method
_build_schema
fenic.core._logical_plan.plans.join.Join._build_schema
null
site-packages/fenic/core/_logical_plan/plans/join.py
false
true
77
124
null
Schema
[ "self", "session_state" ]
Join
null
null
Type: method Member Name: _build_schema Qualified Name: fenic.core._logical_plan.plans.join.Join._build_schema Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "session_state"] Returns: Schema Parent Class: Join
method
_repr
fenic.core._logical_plan.plans.join.Join._repr
null
site-packages/fenic/core/_logical_plan/plans/join.py
false
true
126
127
null
str
[ "self" ]
Join
null
null
Type: method Member Name: _repr Qualified Name: fenic.core._logical_plan.plans.join.Join._repr Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self"] Returns: str Parent Class: Join
method
left_on
fenic.core._logical_plan.plans.join.Join.left_on
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
129
130
null
List[LogicalExpr]
[ "self" ]
Join
null
null
Type: method Member Name: left_on Qualified Name: fenic.core._logical_plan.plans.join.Join.left_on Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: Join
method
right_on
fenic.core._logical_plan.plans.join.Join.right_on
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
132
133
null
List[LogicalExpr]
[ "self" ]
Join
null
null
Type: method Member Name: right_on Qualified Name: fenic.core._logical_plan.plans.join.Join.right_on Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: Join
method
how
fenic.core._logical_plan.plans.join.Join.how
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
135
136
null
str
[ "self" ]
Join
null
null
Type: method Member Name: how Qualified Name: fenic.core._logical_plan.plans.join.Join.how Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: Join
method
with_children
fenic.core._logical_plan.plans.join.Join.with_children
null
site-packages/fenic/core/_logical_plan/plans/join.py
true
false
138
143
null
LogicalPlan
[ "self", "children", "session_state" ]
Join
null
null
Type: method Member Name: with_children Qualified Name: fenic.core._logical_plan.plans.join.Join.with_children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "children", "session_state"] Returns: LogicalPlan Parent Class: Join
method
_eq_specific
fenic.core._logical_plan.plans.join.Join._eq_specific
null
site-packages/fenic/core/_logical_plan/plans/join.py
false
true
145
150
null
bool
[ "self", "other" ]
Join
null
null
Type: method Member Name: _eq_specific Qualified Name: fenic.core._logical_plan.plans.join.Join._eq_specific Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "other"] Returns: bool Parent Class: Join