type stringclasses 5
values | name stringlengths 1 55 | qualified_name stringlengths 5 130 | docstring stringlengths 15 3.11k ⌀ | filepath stringclasses 90
values | is_public bool 2
classes | is_private bool 2
classes | line_start int64 0 1.44k ⌀ | line_end int64 0 1.51k ⌀ | annotation stringclasses 2
values | returns stringclasses 82
values | value stringclasses 66
values | parameters listlengths 0 10 ⌀ | bases listlengths 0 2 ⌀ | parent_class stringclasses 193
values | api_element_summary stringlengths 199 3.43k |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
method | to_polars | fenic.core.types.semantic_examples.BaseExampleCollection.to_polars | Convert the collection to a Polars DataFrame.
Returns:
A Polars DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples. | null | true | false | 149 | 157 | null | pl.DataFrame | null | [
"self"
] | null | BaseExampleCollection | Type: method
Member Name: to_polars
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.to_polars
Docstring: Convert the collection to a Polars DataFrame.
Returns:
A Polars DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: pl.DataFrame
Parent Class: BaseExampleCollection |
method | to_pandas | fenic.core.types.semantic_examples.BaseExampleCollection.to_pandas | Convert the collection to a Pandas DataFrame.
Returns:
A Pandas DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples. | null | true | false | 159 | 167 | null | pd.DataFrame | null | [
"self"
] | null | BaseExampleCollection | Type: method
Member Name: to_pandas
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.to_pandas
Docstring: Convert the collection to a Pandas DataFrame.
Returns:
A Pandas DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: pd.DataFrame
Parent Class: BaseExampleCollection |
method | create_example | fenic.core.types.semantic_examples.BaseExampleCollection.create_example | Create an example in the collection.
Args:
example: The semantic example to add. Must be an instance of the
collection's example_class.
Returns:
Self for method chaining. | null | true | false | 169 | 184 | null | BaseExampleCollection | null | [
"self",
"example"
] | null | BaseExampleCollection | Type: method
Member Name: create_example
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.create_example
Docstring: Create an example in the collection.
Args:
example: The semantic example to add. Must be an instance of the
collection's example_class.
Returns:
Self for method chaining.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "example"]
Returns: BaseExampleCollection
Parent Class: BaseExampleCollection |
class | MapExampleCollection | fenic.core.types.semantic_examples.MapExampleCollection | Collection of examples for semantic mapping operations.
Map operations transform input variables into a text output according to
specified instructions. This collection manages examples that demonstrate
the expected transformations for different inputs.
Examples in this collection can have multiple input variables, each mapped
to their respective values, with a single output string representing the
expected transformation result. | null | true | false | 187 | 279 | null | null | null | null | [
"BaseExampleCollection[MapExample]"
] | null | Type: class
Member Name: MapExampleCollection
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection
Docstring: Collection of examples for semantic mapping operations.
Map operations transform input variables into a text output according to
specified instructions. This collection manages examples that demonstrate
the expected transformations for different inputs.
Examples in this collection can have multiple input variables, each mapped
to their respective values, with a single output string representing the
expected transformation result.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | from_polars | fenic.core.types.semantic_examples.MapExampleCollection.from_polars | Create collection from a Polars DataFrame. Must have an 'output' column and at least one input column. | null | true | false | 201 | 231 | null | MapExampleCollection | null | [
"cls",
"df"
] | null | MapExampleCollection | Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame. Must have an 'output' column and at least one input column.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: MapExampleCollection
Parent Class: MapExampleCollection |
method | _as_df_input | fenic.core.types.semantic_examples.MapExampleCollection._as_df_input | Convert examples to a list of dictionaries suitable for DataFrame creation. | null | false | true | 233 | 247 | null | List[Dict[str, Any]] | null | [
"self"
] | null | MapExampleCollection | Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: MapExampleCollection |
method | _validate_with_instruction | fenic.core.types.semantic_examples.MapExampleCollection._validate_with_instruction | Validate that the collection matches the expected input columns from the instruction. | null | false | true | 249 | 279 | null | None | null | [
"self",
"instruction"
] | null | MapExampleCollection | Type: method
Member Name: _validate_with_instruction
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection._validate_with_instruction
Docstring: Validate that the collection matches the expected input columns from the instruction.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "instruction"]
Returns: None
Parent Class: MapExampleCollection |
class | ClassifyExampleCollection | fenic.core.types.semantic_examples.ClassifyExampleCollection | Collection of examples for semantic classification operations.
Classification operations categorize input text into predefined classes.
This collection manages examples that demonstrate the expected classification
results for different inputs.
Examples in this collection have a single input string and an output string
representing the classification result. | null | true | false | 282 | 349 | null | null | null | null | [
"BaseExampleCollection[ClassifyExample]"
] | null | Type: class
Member Name: ClassifyExampleCollection
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection
Docstring: Collection of examples for semantic classification operations.
Classification operations categorize input text into predefined classes.
This collection manages examples that demonstrate the expected classification
results for different inputs.
Examples in this collection have a single input string and an output string
representing the classification result.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | from_polars | fenic.core.types.semantic_examples.ClassifyExampleCollection.from_polars | Create collection from a Polars DataFrame. Must have an 'output' column and an 'input' column. | null | true | false | 295 | 325 | null | ClassifyExampleCollection | null | [
"cls",
"df"
] | null | ClassifyExampleCollection | Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame. Must have an 'output' column and an 'input' column.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: ClassifyExampleCollection
Parent Class: ClassifyExampleCollection |
method | _as_df_input | fenic.core.types.semantic_examples.ClassifyExampleCollection._as_df_input | Convert examples to a list of dictionaries suitable for DataFrame creation. | null | false | true | 327 | 342 | null | List[Dict[str, Any]] | null | [
"self"
] | null | ClassifyExampleCollection | Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: ClassifyExampleCollection |
method | _validate_with_enum | fenic.core.types.semantic_examples.ClassifyExampleCollection._validate_with_enum | null | null | false | true | 344 | 349 | null | None | null | [
"self",
"category"
] | null | ClassifyExampleCollection | Type: method
Member Name: _validate_with_enum
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection._validate_with_enum
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "category"]
Returns: None
Parent Class: ClassifyExampleCollection |
class | PredicateExampleCollection | fenic.core.types.semantic_examples.PredicateExampleCollection | Collection of examples for semantic predicate operations.
Predicate operations evaluate conditions on input variables to produce
boolean (True/False) results. This collection manages examples that
demonstrate the expected boolean outcomes for different inputs.
Examples in this collection can have multiple input variables, each mapped
to their respective values, with a single boolean output representing the
evaluation result of the predicate. | null | true | false | 352 | 443 | null | null | null | null | [
"BaseExampleCollection[PredicateExample]"
] | null | Type: class
Member Name: PredicateExampleCollection
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection
Docstring: Collection of examples for semantic predicate operations.
Predicate operations evaluate conditions on input variables to produce
boolean (True/False) results. This collection manages examples that
demonstrate the expected boolean outcomes for different inputs.
Examples in this collection can have multiple input variables, each mapped
to their respective values, with a single boolean output representing the
evaluation result of the predicate.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | from_polars | fenic.core.types.semantic_examples.PredicateExampleCollection.from_polars | Create collection from a Polars DataFrame. | null | true | false | 366 | 395 | null | PredicateExampleCollection | null | [
"cls",
"df"
] | null | PredicateExampleCollection | Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: PredicateExampleCollection
Parent Class: PredicateExampleCollection |
method | _as_df_input | fenic.core.types.semantic_examples.PredicateExampleCollection._as_df_input | Convert examples to a list of dictionaries suitable for DataFrame creation. | null | false | true | 397 | 411 | null | List[Dict[str, Any]] | null | [
"self"
] | null | PredicateExampleCollection | Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: PredicateExampleCollection |
method | _validate_with_instruction | fenic.core.types.semantic_examples.PredicateExampleCollection._validate_with_instruction | Validate that the collection matches the expected input columns from the instruction. | null | false | true | 413 | 443 | null | None | null | [
"self",
"instruction"
] | null | PredicateExampleCollection | Type: method
Member Name: _validate_with_instruction
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection._validate_with_instruction
Docstring: Validate that the collection matches the expected input columns from the instruction.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "instruction"]
Returns: None
Parent Class: PredicateExampleCollection |
class | JoinExampleCollection | fenic.core.types.semantic_examples.JoinExampleCollection | Collection of examples for semantic join operations. | null | true | false | 446 | 499 | null | null | null | null | [
"BaseExampleCollection[JoinExample]"
] | null | Type: class
Member Name: JoinExampleCollection
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection
Docstring: Collection of examples for semantic join operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | from_polars | fenic.core.types.semantic_examples.JoinExampleCollection.from_polars | Create collection from a Polars DataFrame. Must have 'left', 'right', and 'output' columns. | null | true | false | 451 | 481 | null | JoinExampleCollection | null | [
"cls",
"df"
] | null | JoinExampleCollection | Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame. Must have 'left', 'right', and 'output' columns.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: JoinExampleCollection
Parent Class: JoinExampleCollection |
method | _as_df_input | fenic.core.types.semantic_examples.JoinExampleCollection._as_df_input | Convert examples to a list of dictionaries suitable for DataFrame creation. | null | false | true | 483 | 499 | null | List[Dict[str, Any]] | null | [
"self"
] | null | JoinExampleCollection | Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: JoinExampleCollection |
module | schema | fenic.core.types.schema | Schema definitions for DataFrame structures.
This module provides classes for defining and working with DataFrame schemas.
It includes ColumnField for individual column definitions and Schema for complete
DataFrame structure definitions. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/types/schema.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: schema
Qualified Name: fenic.core.types.schema
Docstring: Schema definitions for DataFrame structures.
This module provides classes for defining and working with DataFrame schemas.
It includes ColumnField for individual column definitions and Schema for complete
DataFrame structure definitions.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | ColumnField | fenic.core.types.schema.ColumnField | Represents a typed column in a DataFrame schema.
A ColumnField defines the structure of a single column by specifying its name
and data type. This is used as a building block for DataFrame schemas.
Attributes:
name: The name of the column.
data_type: The data type of the column, as a DataType instance. | null | true | false | 15 | 36 | null | null | null | null | [] | null | Type: class
Member Name: ColumnField
Qualified Name: fenic.core.types.schema.ColumnField
Docstring: Represents a typed column in a DataFrame schema.
A ColumnField defines the structure of a single column by specifying its name
and data type. This is used as a building block for DataFrame schemas.
Attributes:
name: The name of the column.
data_type: The data type of the column, as a DataType instance.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.schema.ColumnField.__str__ | Return a string representation of the ColumnField.
Returns:
A string in the format "ColumnField(name='name', data_type=type)". | null | true | false | 30 | 36 | null | str | null | [
"self"
] | null | ColumnField | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.schema.ColumnField.__str__
Docstring: Return a string representation of the ColumnField.
Returns:
A string in the format "ColumnField(name='name', data_type=type)".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: ColumnField |
class | Schema | fenic.core.types.schema.Schema | Represents the schema of a DataFrame.
A Schema defines the structure of a DataFrame by specifying an ordered collection
of column fields. Each column field defines the name and data type of a column
in the DataFrame.
Attributes:
column_fields: An ordered list of ColumnField objects that define the
structure of the DataFrame. | null | true | false | 39 | 68 | null | null | null | null | [] | null | Type: class
Member Name: Schema
Qualified Name: fenic.core.types.schema.Schema
Docstring: Represents the schema of a DataFrame.
A Schema defines the structure of a DataFrame by specifying an ordered collection
of column fields. Each column field defines the name and data type of a column
in the DataFrame.
Attributes:
column_fields: An ordered list of ColumnField objects that define the
structure of the DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.schema.Schema.__str__ | Return a string representation of the Schema.
Returns:
A string containing a comma-separated list of column field representations. | null | true | false | 54 | 60 | null | str | null | [
"self"
] | null | Schema | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.schema.Schema.__str__
Docstring: Return a string representation of the Schema.
Returns:
A string containing a comma-separated list of column field representations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: Schema |
method | column_names | fenic.core.types.schema.Schema.column_names | Get a list of all column names in the schema.
Returns:
A list of strings containing the names of all columns in the schema. | null | true | false | 62 | 68 | null | List[str] | null | [
"self"
] | null | Schema | Type: method
Member Name: column_names
Qualified Name: fenic.core.types.schema.Schema.column_names
Docstring: Get a list of all column names in the schema.
Returns:
A list of strings containing the names of all columns in the schema.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: Schema |
module | _interfaces | fenic.core._interfaces | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_interfaces/__init__.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _interfaces
Qualified Name: fenic.core._interfaces
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.core._interfaces.__all__ | null | null | false | false | 6 | 6 | null | null | ['BaseLineage', 'BaseExecution', 'BaseSessionState', 'BaseCatalog'] | null | null | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.core._interfaces.__all__
Docstring: none
Value: ['BaseLineage', 'BaseExecution', 'BaseSessionState', 'BaseCatalog']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | catalog | fenic.core._interfaces.catalog | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_interfaces/catalog.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: catalog
Qualified Name: fenic.core._interfaces.catalog
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | BaseCatalog | fenic.core._interfaces.catalog.BaseCatalog | null | null | true | false | 7 | 93 | null | null | null | null | [
"ABC"
] | null | Type: class
Member Name: BaseCatalog
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | does_catalog_exist | fenic.core._interfaces.catalog.BaseCatalog.does_catalog_exist | Checks if a catalog with the specified name exists. | null | true | false | 9 | 12 | null | bool | null | [
"self",
"catalog_name"
] | null | BaseCatalog | Type: method
Member Name: does_catalog_exist
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.does_catalog_exist
Docstring: Checks if a catalog with the specified name exists.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "catalog_name"]
Returns: bool
Parent Class: BaseCatalog |
method | get_current_catalog | fenic.core._interfaces.catalog.BaseCatalog.get_current_catalog | Get the name of the current catalog. | null | true | false | 14 | 17 | null | str | null | [
"self"
] | null | BaseCatalog | Type: method
Member Name: get_current_catalog
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.get_current_catalog
Docstring: Get the name of the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: BaseCatalog |
method | set_current_catalog | fenic.core._interfaces.catalog.BaseCatalog.set_current_catalog | Set the current catalog. | null | true | false | 19 | 22 | null | None | null | [
"self",
"catalog_name"
] | null | BaseCatalog | Type: method
Member Name: set_current_catalog
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.set_current_catalog
Docstring: Set the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "catalog_name"]
Returns: None
Parent Class: BaseCatalog |
method | list_catalogs | fenic.core._interfaces.catalog.BaseCatalog.list_catalogs | Get a list of all catalogs. | null | true | false | 24 | 27 | null | List[str] | null | [
"self"
] | null | BaseCatalog | Type: method
Member Name: list_catalogs
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_catalogs
Docstring: Get a list of all catalogs.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseCatalog |
method | does_database_exist | fenic.core._interfaces.catalog.BaseCatalog.does_database_exist | Checks if a database with the specified name exists in the current catalog. | null | true | false | 30 | 33 | null | bool | null | [
"self",
"database_name"
] | null | BaseCatalog | Type: method
Member Name: does_database_exist
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.does_database_exist
Docstring: Checks if a database with the specified name exists in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name"]
Returns: bool
Parent Class: BaseCatalog |
method | get_current_database | fenic.core._interfaces.catalog.BaseCatalog.get_current_database | Get the name of the current database in the current catalog. | null | true | false | 35 | 38 | null | str | null | [
"self"
] | null | BaseCatalog | Type: method
Member Name: get_current_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.get_current_database
Docstring: Get the name of the current database in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: BaseCatalog |
method | set_current_database | fenic.core._interfaces.catalog.BaseCatalog.set_current_database | Set the current database in the current catalog. | null | true | false | 40 | 43 | null | None | null | [
"self",
"database_name"
] | null | BaseCatalog | Type: method
Member Name: set_current_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.set_current_database
Docstring: Set the current database in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name"]
Returns: None
Parent Class: BaseCatalog |
method | list_databases | fenic.core._interfaces.catalog.BaseCatalog.list_databases | Get a list of all databases in the current catalog. | null | true | false | 45 | 48 | null | List[str] | null | [
"self"
] | null | BaseCatalog | Type: method
Member Name: list_databases
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_databases
Docstring: Get a list of all databases in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseCatalog |
method | create_database | fenic.core._interfaces.catalog.BaseCatalog.create_database | Create a new database in the current catalog. | null | true | false | 50 | 55 | null | bool | null | [
"self",
"database_name",
"ignore_if_exists"
] | null | BaseCatalog | Type: method
Member Name: create_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.create_database
Docstring: Create a new database in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name", "ignore_if_exists"]
Returns: bool
Parent Class: BaseCatalog |
method | drop_database | fenic.core._interfaces.catalog.BaseCatalog.drop_database | Drop a database from the current catalog. | null | true | false | 57 | 65 | null | bool | null | [
"self",
"database_name",
"cascade",
"ignore_if_not_exists"
] | null | BaseCatalog | Type: method
Member Name: drop_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.drop_database
Docstring: Drop a database from the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name", "cascade", "ignore_if_not_exists"]
Returns: bool
Parent Class: BaseCatalog |
method | does_table_exist | fenic.core._interfaces.catalog.BaseCatalog.does_table_exist | Checks if a table with the specified name exists in the current database. | null | true | false | 68 | 71 | null | bool | null | [
"self",
"table_name"
] | null | BaseCatalog | Type: method
Member Name: does_table_exist
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.does_table_exist
Docstring: Checks if a table with the specified name exists in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name"]
Returns: bool
Parent Class: BaseCatalog |
method | list_tables | fenic.core._interfaces.catalog.BaseCatalog.list_tables | Get a list of all tables in the current database. | null | true | false | 73 | 76 | null | List[str] | null | [
"self"
] | null | BaseCatalog | Type: method
Member Name: list_tables
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_tables
Docstring: Get a list of all tables in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseCatalog |
method | describe_table | fenic.core._interfaces.catalog.BaseCatalog.describe_table | Get the schema of the specified table. | null | true | false | 78 | 81 | null | Schema | null | [
"self",
"table_name"
] | null | BaseCatalog | Type: method
Member Name: describe_table
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.describe_table
Docstring: Get the schema of the specified table.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name"]
Returns: Schema
Parent Class: BaseCatalog |
method | drop_table | fenic.core._interfaces.catalog.BaseCatalog.drop_table | Drop a table from the current database. | null | true | false | 83 | 86 | null | bool | null | [
"self",
"table_name",
"ignore_if_not_exists"
] | null | BaseCatalog | Type: method
Member Name: drop_table
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.drop_table
Docstring: Drop a table from the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name", "ignore_if_not_exists"]
Returns: bool
Parent Class: BaseCatalog |
method | create_table | fenic.core._interfaces.catalog.BaseCatalog.create_table | Create a new table in the current database. | null | true | false | 88 | 93 | null | bool | null | [
"self",
"table_name",
"schema",
"ignore_if_exists"
] | null | BaseCatalog | Type: method
Member Name: create_table
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.create_table
Docstring: Create a new table in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name", "schema", "ignore_if_exists"]
Returns: bool
Parent Class: BaseCatalog |
module | execution | fenic.core._interfaces.execution | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_interfaces/execution.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: execution
Qualified Name: fenic.core._interfaces.execution
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | BaseExecution | fenic.core._interfaces.execution.BaseExecution | null | null | true | false | 15 | 70 | null | null | null | null | [
"ABC"
] | null | Type: class
Member Name: BaseExecution
Qualified Name: fenic.core._interfaces.execution.BaseExecution
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | collect | fenic.core._interfaces.execution.BaseExecution.collect | Execute a logical plan and return a Polars DataFrame and query metrics. | null | true | false | 16 | 21 | null | Tuple[pl.DataFrame, QueryMetrics] | null | [
"self",
"plan",
"n"
] | null | BaseExecution | Type: method
Member Name: collect
Qualified Name: fenic.core._interfaces.execution.BaseExecution.collect
Docstring: Execute a logical plan and return a Polars DataFrame and query metrics.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan", "n"]
Returns: Tuple[pl.DataFrame, QueryMetrics]
Parent Class: BaseExecution |
method | show | fenic.core._interfaces.execution.BaseExecution.show | Execute a logical plan and return a string representation of the sample rows of the DataFrame and query metrics. | null | true | false | 23 | 26 | null | Tuple[str, QueryMetrics] | null | [
"self",
"plan",
"n"
] | null | BaseExecution | Type: method
Member Name: show
Qualified Name: fenic.core._interfaces.execution.BaseExecution.show
Docstring: Execute a logical plan and return a string representation of the sample rows of the DataFrame and query metrics.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan", "n"]
Returns: Tuple[str, QueryMetrics]
Parent Class: BaseExecution |
method | count | fenic.core._interfaces.execution.BaseExecution.count | Execute a logical plan and return the number of rows in the DataFrame and query metrics. | null | true | false | 28 | 31 | null | Tuple[int, QueryMetrics] | null | [
"self",
"plan"
] | null | BaseExecution | Type: method
Member Name: count
Qualified Name: fenic.core._interfaces.execution.BaseExecution.count
Docstring: Execute a logical plan and return the number of rows in the DataFrame and query metrics.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan"]
Returns: Tuple[int, QueryMetrics]
Parent Class: BaseExecution |
method | build_lineage | fenic.core._interfaces.execution.BaseExecution.build_lineage | Build a lineage graph from a logical plan. | null | true | false | 33 | 36 | null | BaseLineage | null | [
"self",
"plan"
] | null | BaseExecution | Type: method
Member Name: build_lineage
Qualified Name: fenic.core._interfaces.execution.BaseExecution.build_lineage
Docstring: Build a lineage graph from a logical plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan"]
Returns: BaseLineage
Parent Class: BaseExecution |
method | save_as_table | fenic.core._interfaces.execution.BaseExecution.save_as_table | Execute the logical plan and save the result as a table in the current database. | null | true | false | 38 | 46 | null | QueryMetrics | null | [
"self",
"logical_plan",
"table_name",
"mode"
] | null | BaseExecution | Type: method
Member Name: save_as_table
Qualified Name: fenic.core._interfaces.execution.BaseExecution.save_as_table
Docstring: Execute the logical plan and save the result as a table in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "logical_plan", "table_name", "mode"]
Returns: QueryMetrics
Parent Class: BaseExecution |
method | save_to_file | fenic.core._interfaces.execution.BaseExecution.save_to_file | Execute the logical plan and save the result to a file. | null | true | false | 48 | 56 | null | QueryMetrics | null | [
"self",
"logical_plan",
"file_path",
"mode"
] | null | BaseExecution | Type: method
Member Name: save_to_file
Qualified Name: fenic.core._interfaces.execution.BaseExecution.save_to_file
Docstring: Execute the logical plan and save the result to a file.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "logical_plan", "file_path", "mode"]
Returns: QueryMetrics
Parent Class: BaseExecution |
method | infer_schema_from_csv | fenic.core._interfaces.execution.BaseExecution.infer_schema_from_csv | Infer the schema of a CSV file. | null | true | false | 58 | 63 | null | Schema | null | [
"self",
"paths",
"options"
] | null | BaseExecution | Type: method
Member Name: infer_schema_from_csv
Qualified Name: fenic.core._interfaces.execution.BaseExecution.infer_schema_from_csv
Docstring: Infer the schema of a CSV file.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "paths", "options"]
Returns: Schema
Parent Class: BaseExecution |
method | infer_schema_from_parquet | fenic.core._interfaces.execution.BaseExecution.infer_schema_from_parquet | Infer the schema of a Parquet file. | null | true | false | 65 | 70 | null | Schema | null | [
"self",
"paths",
"options"
] | null | BaseExecution | Type: method
Member Name: infer_schema_from_parquet
Qualified Name: fenic.core._interfaces.execution.BaseExecution.infer_schema_from_parquet
Docstring: Infer the schema of a Parquet file.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "paths", "options"]
Returns: Schema
Parent Class: BaseExecution |
module | session_state | fenic.core._interfaces.session_state | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_interfaces/session_state.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: session_state
Qualified Name: fenic.core._interfaces.session_state
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | BaseSessionState | fenic.core._interfaces.session_state.BaseSessionState | null | null | true | false | 8 | 27 | null | null | null | null | [
"ABC"
] | null | Type: class
Member Name: BaseSessionState
Qualified Name: fenic.core._interfaces.session_state.BaseSessionState
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.core._interfaces.session_state.BaseSessionState.__init__ | null | null | true | false | 9 | 10 | null | null | null | [
"self",
"session_config"
] | null | BaseSessionState | Type: method
Member Name: __init__
Qualified Name: fenic.core._interfaces.session_state.BaseSessionState.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "session_config"]
Returns: none
Parent Class: BaseSessionState |
method | stop | fenic.core._interfaces.session_state.BaseSessionState.stop | Clean up the session state. | null | true | false | 24 | 27 | null | None | null | [
"self"
] | null | BaseSessionState | Type: method
Member Name: stop
Qualified Name: fenic.core._interfaces.session_state.BaseSessionState.stop
Docstring: Clean up the session state.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: BaseSessionState |
module | lineage | fenic.core._interfaces.lineage | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_interfaces/lineage.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: lineage
Qualified Name: fenic.core._interfaces.lineage
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | BaseLineage | fenic.core._interfaces.lineage.BaseLineage | Base class for lineage traversal implementations. | null | true | false | 9 | 47 | null | null | null | null | [
"ABC"
] | null | Type: class
Member Name: BaseLineage
Qualified Name: fenic.core._interfaces.lineage.BaseLineage
Docstring: Base class for lineage traversal implementations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | get_source_names | fenic.core._interfaces.lineage.BaseLineage.get_source_names | Get the names of all sources in the query plan. Used to determine where to start the lineage traversal. | null | true | false | 12 | 15 | null | List[str] | null | [
"self"
] | null | BaseLineage | Type: method
Member Name: get_source_names
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.get_source_names
Docstring: Get the names of all sources in the query plan. Used to determine where to start the lineage traversal.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseLineage |
method | stringify_graph | fenic.core._interfaces.lineage.BaseLineage.stringify_graph | Print the operator tree of the query. | null | true | false | 17 | 20 | null | str | null | [
"self"
] | null | BaseLineage | Type: method
Member Name: stringify_graph
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.stringify_graph
Docstring: Print the operator tree of the query.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: BaseLineage |
method | start_from_source | fenic.core._interfaces.lineage.BaseLineage.start_from_source | Set the current position to a specific source in the query plan. | null | true | false | 22 | 25 | null | None | null | [
"self",
"source_name"
] | null | BaseLineage | Type: method
Member Name: start_from_source
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.start_from_source
Docstring: Set the current position to a specific source in the query plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "source_name"]
Returns: None
Parent Class: BaseLineage |
method | forwards | fenic.core._interfaces.lineage.BaseLineage.forwards | Trace rows forward to see how they are transformed by the next operation. | null | true | false | 27 | 30 | null | pl.DataFrame | null | [
"self",
"ids"
] | null | BaseLineage | Type: method
Member Name: forwards
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.forwards
Docstring: Trace rows forward to see how they are transformed by the next operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "ids"]
Returns: pl.DataFrame
Parent Class: BaseLineage |
method | backwards | fenic.core._interfaces.lineage.BaseLineage.backwards | Trace rows backwards to see which input rows produced them. | null | true | false | 32 | 37 | null | pl.DataFrame | null | [
"self",
"ids",
"branch_side"
] | null | BaseLineage | Type: method
Member Name: backwards
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.backwards
Docstring: Trace rows backwards to see which input rows produced them.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "ids", "branch_side"]
Returns: pl.DataFrame
Parent Class: BaseLineage |
method | get_result_df | fenic.core._interfaces.lineage.BaseLineage.get_result_df | Get the result of the query as a Polars DataFrame. | null | true | false | 39 | 42 | null | pl.DataFrame | null | [
"self"
] | null | BaseLineage | Type: method
Member Name: get_result_df
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.get_result_df
Docstring: Get the result of the query as a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: pl.DataFrame
Parent Class: BaseLineage |
method | get_source_df | fenic.core._interfaces.lineage.BaseLineage.get_source_df | Get a query source by name as a Polars DataFrame. | null | true | false | 44 | 47 | null | pl.DataFrame | null | [
"self",
"source_name"
] | null | BaseLineage | Type: method
Member Name: get_source_df
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.get_source_df
Docstring: Get a query source by name as a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "source_name"]
Returns: pl.DataFrame
Parent Class: BaseLineage |
module | _logical_plan | fenic.core._logical_plan | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_logical_plan/__init__.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _logical_plan
Qualified Name: fenic.core._logical_plan
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.core._logical_plan.__all__ | null | null | false | false | 4 | 7 | null | null | ['LogicalPlan', 'LogicalExpr'] | null | null | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.core._logical_plan.__all__
Docstring: none
Value: ['LogicalPlan', 'LogicalExpr']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | serde | fenic.core._logical_plan.serde | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_logical_plan/serde.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: serde
Qualified Name: fenic.core._logical_plan.serde
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | LogicalPlanSerde | fenic.core._logical_plan.serde.LogicalPlanSerde | null | null | true | false | 7 | 69 | null | null | null | null | [] | null | Type: class
Member Name: LogicalPlanSerde
Qualified Name: fenic.core._logical_plan.serde.LogicalPlanSerde
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | serialize | fenic.core._logical_plan.serde.LogicalPlanSerde.serialize | Serialize a LogicalPlan to bytes using pickle.
Removes any local session state refs from the plan.
Args:
plan: The LogicalPlan to serialize
Returns:
bytes: The serialized plan | null | true | false | 8 | 38 | null | bytes | null | [
"plan"
] | null | LogicalPlanSerde | Type: method
Member Name: serialize
Qualified Name: fenic.core._logical_plan.serde.LogicalPlanSerde.serialize
Docstring: Serialize a LogicalPlan to bytes using pickle.
Removes any local session state refs from the plan.
Args:
plan: The LogicalPlan to serialize
Returns:
bytes: The serialized plan
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["plan"]
Returns: bytes
Parent Class: LogicalPlanSerde |
method | deserialize | fenic.core._logical_plan.serde.LogicalPlanSerde.deserialize | Deserialize bytes back into a LogicalPlan using pickle.
Args:
data: The serialized plan data
Returns:
The deserialized plan | null | true | false | 40 | 50 | null | LogicalPlan | null | [
"data"
] | null | LogicalPlanSerde | Type: method
Member Name: deserialize
Qualified Name: fenic.core._logical_plan.serde.LogicalPlanSerde.deserialize
Docstring: Deserialize bytes back into a LogicalPlan using pickle.
Args:
data: The serialized plan data
Returns:
The deserialized plan
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["data"]
Returns: LogicalPlan
Parent Class: LogicalPlanSerde |
method | build_logical_plan_with_session_state | fenic.core._logical_plan.serde.LogicalPlanSerde.build_logical_plan_with_session_state | Build a LogicalPlan with the session state.
Args:
plan: The LogicalPlan to build
session: The session state | null | true | false | 52 | 69 | null | LogicalPlan | null | [
"plan",
"session"
] | null | LogicalPlanSerde | Type: method
Member Name: build_logical_plan_with_session_state
Qualified Name: fenic.core._logical_plan.serde.LogicalPlanSerde.build_logical_plan_with_session_state
Docstring: Build a LogicalPlan with the session state.
Args:
plan: The LogicalPlan to build
session: The session state
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["plan", "session"]
Returns: LogicalPlan
Parent Class: LogicalPlanSerde |
module | utils | fenic.core._logical_plan.utils | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_logical_plan/utils.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: utils
Qualified Name: fenic.core._logical_plan.utils
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
function | validate_completion_parameters | fenic.core._logical_plan.utils.validate_completion_parameters | Validates that the provided temperature and max_tokens are within the limits allowed by the specified language model.
If no model alias is provided, the session's default language model is used.
Parameters:
model_alias (Optional[str]):
Alias of the language model to validate. Defaults to the session's
default if not provided.
resolved_session_config (ResolvedSessionConfig):
The resolved session config containing model definitions.
temperature (float):
Sampling temperature. Must be within the model's supported range.
max_tokens (Optional[int]):
Maximum number of tokens to generate. Must not exceed the model's limit.
Raises:
ValidationError: If temperature or max_tokens are out of bounds for the model. | null | true | false | 16 | 58 | null | null | null | [
"model_alias",
"resolved_session_config",
"temperature",
"max_tokens"
] | null | null | Type: function
Member Name: validate_completion_parameters
Qualified Name: fenic.core._logical_plan.utils.validate_completion_parameters
Docstring: Validates that the provided temperature and max_tokens are within the limits allowed by the specified language model.
If no model alias is provided, the session's default language model is used.
Parameters:
model_alias (Optional[str]):
Alias of the language model to validate. Defaults to the session's
default if not provided.
resolved_session_config (ResolvedSessionConfig):
The resolved session config containing model definitions.
temperature (float):
Sampling temperature. Must be within the model's supported range.
max_tokens (Optional[int]):
Maximum number of tokens to generate. Must not exceed the model's limit.
Raises:
ValidationError: If temperature or max_tokens are out of bounds for the model.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["model_alias", "resolved_session_config", "temperature", "max_tokens"]
Returns: none
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. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/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 | null | true | false | 26 | 33 | null | null | ['LogicalPlanOptimizerRule', 'MergeFiltersRule', 'NotFilterPushdownRule', 'SemanticFilterRewriteRule', 'OptimizationResult', 'LogicalPlanOptimizer'] | null | null | 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 | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/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. | null | true | false | 19 | 148 | null | null | null | null | [
"LogicalPlanOptimizerRule"
] | null | 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 | null | true | false | 43 | 44 | null | OptimizationResult | null | [
"self",
"logical_plan"
] | null | SemanticFilterRewriteRule | 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"]
Returns: OptimizationResult
Parent Class: SemanticFilterRewriteRule |
method | optimize_node | fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.optimize_node | null | null | true | false | 46 | 63 | null | OptimizationResult | null | [
"self",
"node"
] | null | SemanticFilterRewriteRule | 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"]
Returns: OptimizationResult
Parent Class: SemanticFilterRewriteRule |
method | optimize_filter | fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.optimize_filter | null | null | true | false | 65 | 95 | null | OptimizationResult | null | [
"self",
"node"
] | null | SemanticFilterRewriteRule | 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"]
Returns: OptimizationResult
Parent Class: SemanticFilterRewriteRule |
method | partition_predicates | fenic.core._logical_plan.optimizer.semantic_filter_rewrite_rule.SemanticFilterRewriteRule.partition_predicates | null | null | true | false | 100 | 119 | null | Tuple[List[LogicalExpr], List[LogicalExpr]] | null | [
"self",
"predicate"
] | null | SemanticFilterRewriteRule | 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. | null | false | true | 121 | 132 | null | LogicalExpr | null | [
"predicates"
] | null | SemanticFilterRewriteRule | 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. | null | true | false | 134 | 144 | null | int | null | [
"expr"
] | null | SemanticFilterRewriteRule | 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 | null | true | false | 146 | 148 | null | bool | null | [
"expr"
] | null | SemanticFilterRewriteRule | 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 | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/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. | null | true | false | 15 | 113 | null | null | null | null | [
"LogicalPlanOptimizerRule"
] | null | 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 | null | true | false | 29 | 30 | null | OptimizationResult | null | [
"self",
"logical_plan"
] | null | NotFilterPushdownRule | 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"]
Returns: OptimizationResult
Parent Class: NotFilterPushdownRule |
method | optimize_node | fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.optimize_node | null | null | true | false | 32 | 52 | null | OptimizationResult | null | [
"self",
"node"
] | null | NotFilterPushdownRule | 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"]
Returns: OptimizationResult
Parent Class: NotFilterPushdownRule |
method | optimize_filter | fenic.core._logical_plan.optimizer.not_filter_pushdown_rule.NotFilterPushdownRule.optimize_filter | null | null | true | false | 54 | 67 | null | OptimizationResult | null | [
"self",
"node"
] | null | NotFilterPushdownRule | 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"]
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. | null | true | false | 69 | 109 | null | LogicalExpr | null | [
"self",
"expr"
] | null | NotFilterPushdownRule | 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 | null | true | false | 111 | 113 | null | bool | null | [
"expr"
] | null | NotFilterPushdownRule | 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 | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/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. | null | true | false | 10 | 50 | null | null | null | null | [
"LogicalPlanOptimizerRule"
] | null | 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 | null | true | false | 17 | 19 | null | OptimizationResult | null | [
"self",
"logical_plan"
] | null | MergeFiltersRule | 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"]
Returns: OptimizationResult
Parent Class: MergeFiltersRule |
method | optimize_node | fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.optimize_node | null | null | true | false | 21 | 38 | null | OptimizationResult | null | [
"self",
"node"
] | null | MergeFiltersRule | 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"]
Returns: OptimizationResult
Parent Class: MergeFiltersRule |
method | merge_filter | fenic.core._logical_plan.optimizer.merge_filters_rule.MergeFiltersRule.merge_filter | null | null | true | false | 40 | 50 | null | OptimizationResult | null | [
"self",
"node"
] | null | MergeFiltersRule | 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"]
Returns: OptimizationResult
Parent Class: MergeFiltersRule |
module | base | fenic.core._logical_plan.optimizer.base | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/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. | null | true | false | 8 | 16 | 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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.