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 | __rand__ | fenic.api.column.Column.__rand__ | Reverse logical AND operation. | site-packages/fenic/api/column.py | true | false | 807 | 809 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __rand__
Qualified Name: fenic.api.column.Column.__rand__
Docstring: Reverse logical AND operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __or__ | fenic.api.column.Column.__or__ | Logical OR operation. | site-packages/fenic/api/column.py | true | false | 811 | 813 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __or__
Qualified Name: fenic.api.column.Column.__or__
Docstring: Logical OR operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __ror__ | fenic.api.column.Column.__ror__ | Reverse logical OR operation. | site-packages/fenic/api/column.py | true | false | 815 | 817 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __ror__
Qualified Name: fenic.api.column.Column.__ror__
Docstring: Reverse logical OR operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __add__ | fenic.api.column.Column.__add__ | Addition operation. | site-packages/fenic/api/column.py | true | false | 819 | 821 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __add__
Qualified Name: fenic.api.column.Column.__add__
Docstring: Addition operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __radd__ | fenic.api.column.Column.__radd__ | Reverse addition operation. | site-packages/fenic/api/column.py | true | false | 823 | 827 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __radd__
Qualified Name: fenic.api.column.Column.__radd__
Docstring: Reverse addition operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __sub__ | fenic.api.column.Column.__sub__ | Subtraction operation. | site-packages/fenic/api/column.py | true | false | 829 | 831 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __sub__
Qualified Name: fenic.api.column.Column.__sub__
Docstring: Subtraction operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __rsub__ | fenic.api.column.Column.__rsub__ | Reverse subtraction operation. | site-packages/fenic/api/column.py | true | false | 833 | 837 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __rsub__
Qualified Name: fenic.api.column.Column.__rsub__
Docstring: Reverse subtraction operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __mul__ | fenic.api.column.Column.__mul__ | Multiplication operation. | site-packages/fenic/api/column.py | true | false | 839 | 841 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __mul__
Qualified Name: fenic.api.column.Column.__mul__
Docstring: Multiplication operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __rmul__ | fenic.api.column.Column.__rmul__ | Reverse multiplication operation. | site-packages/fenic/api/column.py | true | false | 843 | 845 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __rmul__
Qualified Name: fenic.api.column.Column.__rmul__
Docstring: Reverse multiplication operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __truediv__ | fenic.api.column.Column.__truediv__ | Division operation. | site-packages/fenic/api/column.py | true | false | 847 | 849 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __truediv__
Qualified Name: fenic.api.column.Column.__truediv__
Docstring: Division operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __rtruediv__ | fenic.api.column.Column.__rtruediv__ | Reverse division operation. | site-packages/fenic/api/column.py | true | false | 851 | 855 | null | Column | [
"self",
"other"
] | Column | null | null | Type: method
Member Name: __rtruediv__
Qualified Name: fenic.api.column.Column.__rtruediv__
Docstring: Reverse division operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __bool__ | fenic.api.column.Column.__bool__ | Prevent boolean conversion of Column objects. | site-packages/fenic/api/column.py | true | false | 857 | 861 | null | null | [
"self"
] | Column | null | null | Type: method
Member Name: __bool__
Qualified Name: fenic.api.column.Column.__bool__
Docstring: Prevent boolean conversion of Column objects.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: Column |
attribute | ColumnOrName | fenic.api.column.ColumnOrName | null | site-packages/fenic/api/column.py | true | false | 863 | 863 | null | null | null | null | Union[Column, str] | null | Type: attribute
Member Name: ColumnOrName
Qualified Name: fenic.api.column.ColumnOrName
Docstring: none
Value: Union[Column, str]
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | dataframe | fenic.api.dataframe | DataFrame API for Fenic - provides DataFrame and grouped data operations. | site-packages/fenic/api/dataframe/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: dataframe
Qualified Name: fenic.api.dataframe
Docstring: DataFrame API for Fenic - provides DataFrame and grouped data operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.api.dataframe.__all__ | null | site-packages/fenic/api/dataframe/__init__.py | false | false | 9 | 9 | null | null | null | null | ['DataFrame', 'GroupedData', 'SemanticExtensions'] | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.api.dataframe.__all__
Docstring: none
Value: ['DataFrame', 'GroupedData', 'SemanticExtensions']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | _base_grouped_data | fenic.api.dataframe._base_grouped_data | null | site-packages/fenic/api/dataframe/_base_grouped_data.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _base_grouped_data
Qualified Name: fenic.api.dataframe._base_grouped_data
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
class | BaseGroupedData | fenic.api.dataframe._base_grouped_data.BaseGroupedData | Base class for aggregation methods shared between GroupedData and SemanticallyGroupedData. | site-packages/fenic/api/dataframe/_base_grouped_data.py | true | false | 14 | 83 | null | null | null | null | null | [] | Type: class
Member Name: BaseGroupedData
Qualified Name: fenic.api.dataframe._base_grouped_data.BaseGroupedData
Docstring: Base class for aggregation methods shared between GroupedData and SemanticallyGroupedData.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent C... |
method | __init__ | fenic.api.dataframe._base_grouped_data.BaseGroupedData.__init__ | null | site-packages/fenic/api/dataframe/_base_grouped_data.py | true | false | 17 | 18 | null | null | [
"self",
"df"
] | BaseGroupedData | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.api.dataframe._base_grouped_data.BaseGroupedData.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "df"]
Returns: none
Parent Class: BaseGroupedData |
method | _process_agg_dict | fenic.api.dataframe._base_grouped_data.BaseGroupedData._process_agg_dict | Process dictionary-style aggregation specifications. | site-packages/fenic/api/dataframe/_base_grouped_data.py | false | true | 20 | 40 | null | List[Column] | [
"self",
"agg_dict"
] | BaseGroupedData | null | null | Type: method
Member Name: _process_agg_dict
Qualified Name: fenic.api.dataframe._base_grouped_data.BaseGroupedData._process_agg_dict
Docstring: Process dictionary-style aggregation specifications.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "agg_dict"]
Returns: List[Column]
P... |
method | _process_agg_exprs | fenic.api.dataframe._base_grouped_data.BaseGroupedData._process_agg_exprs | Process Column-style aggregation expressions. | site-packages/fenic/api/dataframe/_base_grouped_data.py | false | true | 42 | 59 | null | List[AliasExpr] | [
"self",
"cols"
] | BaseGroupedData | null | null | Type: method
Member Name: _process_agg_exprs
Qualified Name: fenic.api.dataframe._base_grouped_data.BaseGroupedData._process_agg_exprs
Docstring: Process Column-style aggregation expressions.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "cols"]
Returns: List[AliasExpr]
Parent ... |
method | _validate_agg_exprs | fenic.api.dataframe._base_grouped_data.BaseGroupedData._validate_agg_exprs | Validate aggregation expressions. | site-packages/fenic/api/dataframe/_base_grouped_data.py | false | true | 61 | 83 | null | None | [
"self",
"exprs"
] | BaseGroupedData | null | null | Type: method
Member Name: _validate_agg_exprs
Qualified Name: fenic.api.dataframe._base_grouped_data.BaseGroupedData._validate_agg_exprs
Docstring: Validate aggregation expressions.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "exprs"]
Returns: None
Parent Class: BaseGroupedDa... |
module | dataframe | fenic.api.dataframe.dataframe | DataFrame class providing PySpark-inspired API for data manipulation. | site-packages/fenic/api/dataframe/dataframe.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: dataframe
Qualified Name: fenic.api.dataframe.dataframe
Docstring: DataFrame class providing PySpark-inspired API for data manipulation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | logger | fenic.api.dataframe.dataframe.logger | null | site-packages/fenic/api/dataframe/dataframe.py | true | false | 54 | 54 | null | null | null | null | logging.getLogger(__name__) | null | Type: attribute
Member Name: logger
Qualified Name: fenic.api.dataframe.dataframe.logger
Docstring: none
Value: logging.getLogger(__name__)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | DataFrame | fenic.api.dataframe.dataframe.DataFrame | A data collection organized into named columns.
The DataFrame class represents a lazily evaluated computation on data. Operations on
DataFrame build up a logical query plan that is only executed when an action like
show(), to_polars(), to_pandas(), to_arrow(), to_pydict(), to_pylist(), or count() is called.
The DataF... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 57 | 1,560 | null | null | null | null | null | [] | Type: class
Member Name: DataFrame
Qualified Name: fenic.api.dataframe.dataframe.DataFrame
Docstring: A data collection organized into named columns.
The DataFrame class represents a lazily evaluated computation on data. Operations on
DataFrame build up a logical query plan that is only executed when an action like
sh... |
method | __new__ | fenic.api.dataframe.dataframe.DataFrame.__new__ | Prevent direct DataFrame construction.
DataFrames must be created through Session.create_dataframe(). | site-packages/fenic/api/dataframe/dataframe.py | true | false | 89 | 98 | null | null | [
"cls"
] | DataFrame | null | null | Type: method
Member Name: __new__
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.__new__
Docstring: Prevent direct DataFrame construction.
DataFrames must be created through Session.create_dataframe().
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls"]
Returns: none
Parent ... |
method | _from_logical_plan | fenic.api.dataframe.dataframe.DataFrame._from_logical_plan | Factory method to create DataFrame instances.
This method is intended for internal use by the Session class and other
DataFrame methods that need to create new DataFrame instances.
Args:
logical_plan: The logical plan for this DataFrame
session_state: The session state for this DataFrame
Returns:
A new D... | site-packages/fenic/api/dataframe/dataframe.py | false | true | 100 | 123 | null | DataFrame | [
"cls",
"logical_plan",
"session_state"
] | DataFrame | null | null | Type: method
Member Name: _from_logical_plan
Qualified Name: fenic.api.dataframe.dataframe.DataFrame._from_logical_plan
Docstring: Factory method to create DataFrame instances.
This method is intended for internal use by the Session class and other
DataFrame methods that need to create new DataFrame instances.
Args:
... |
method | __getitem__ | fenic.api.dataframe.dataframe.DataFrame.__getitem__ | Enable DataFrame[column_name] syntax for column access.
Args:
col_name: Name of the column to access
Returns:
Column: Column object for the specified column
Raises:
TypeError: If item is not a string
Examples:
>>> df[col("age")] # Returns Column object for "age"
>>> df.filter(df[col("age")] > 2... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 168 | 196 | null | Column | [
"self",
"col_name"
] | DataFrame | null | null | Type: method
Member Name: __getitem__
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.__getitem__
Docstring: Enable DataFrame[column_name] syntax for column access.
Args:
col_name: Name of the column to access
Returns:
Column: Column object for the specified column
Raises:
TypeError: If item is n... |
method | __getattr__ | fenic.api.dataframe.dataframe.DataFrame.__getattr__ | Enable DataFrame.column_name syntax for column access.
Args:
col_name: Name of the column to access
Returns:
Column: Column object for the specified column
Raises:
TypeError: If col_name is not a string
Examples:
>>> df.age # Returns Column object for "age"
>>> df.filter(col("age") > 25) # Use... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 198 | 225 | null | Column | [
"self",
"col_name"
] | DataFrame | null | null | Type: method
Member Name: __getattr__
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.__getattr__
Docstring: Enable DataFrame.column_name syntax for column access.
Args:
col_name: Name of the column to access
Returns:
Column: Column object for the specified column
Raises:
TypeError: If col_name i... |
method | explain | fenic.api.dataframe.dataframe.DataFrame.explain | Display the logical plan of the DataFrame. | site-packages/fenic/api/dataframe/dataframe.py | true | false | 227 | 229 | null | None | [
"self"
] | DataFrame | null | null | Type: method
Member Name: explain
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.explain
Docstring: Display the logical plan of the DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: DataFrame |
method | show | fenic.api.dataframe.dataframe.DataFrame.show | Display the DataFrame content in a tabular form.
This is an action that triggers computation of the DataFrame.
The output is printed to stdout in a formatted table.
Args:
n: Number of rows to display
explain_analyze: Whether to print the explain analyze plan | site-packages/fenic/api/dataframe/dataframe.py | true | false | 231 | 245 | null | None | [
"self",
"n",
"explain_analyze"
] | DataFrame | null | null | Type: method
Member Name: show
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.show
Docstring: Display the DataFrame content in a tabular form.
This is an action that triggers computation of the DataFrame.
The output is printed to stdout in a formatted table.
Args:
n: Number of rows to display
explain... |
method | collect | fenic.api.dataframe.dataframe.DataFrame.collect | Execute the DataFrame computation and return the result as a QueryResult.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results are
materialized into a QueryResult, which contains both the result data and the query metrics.
Args:
... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 247 | 275 | null | QueryResult | [
"self",
"data_type"
] | DataFrame | null | null | Type: method
Member Name: collect
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.collect
Docstring: Execute the DataFrame computation and return the result as a QueryResult.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the result... |
method | to_polars | fenic.api.dataframe.dataframe.DataFrame.to_polars | Execute the DataFrame computation and return the result as a Polars DataFrame.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results are
materialized into a Polars DataFrame.
Returns:
pl.DataFrame: A Polars DataFrame with material... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 277 | 287 | null | pl.DataFrame | [
"self"
] | DataFrame | null | null | Type: method
Member Name: to_polars
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.to_polars
Docstring: Execute the DataFrame computation and return the result as a Polars DataFrame.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and t... |
method | to_pandas | fenic.api.dataframe.dataframe.DataFrame.to_pandas | Execute the DataFrame computation and return a Pandas DataFrame.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results are
materialized into a Pandas DataFrame.
Returns:
pd.DataFrame: A Pandas DataFrame containing the computed res... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 289 | 299 | null | pd.DataFrame | [
"self"
] | DataFrame | null | null | Type: method
Member Name: to_pandas
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.to_pandas
Docstring: Execute the DataFrame computation and return a Pandas DataFrame.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results are... |
method | to_arrow | fenic.api.dataframe.dataframe.DataFrame.to_arrow | Execute the DataFrame computation and return an Apache Arrow Table.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results are
materialized into an Apache Arrow Table with columnar memory layout
optimized for analytics and zero-copy dat... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 301 | 312 | null | pa.Table | [
"self"
] | DataFrame | null | null | Type: method
Member Name: to_arrow
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.to_arrow
Docstring: Execute the DataFrame computation and return an Apache Arrow Table.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results ar... |
method | to_pydict | fenic.api.dataframe.dataframe.DataFrame.to_pydict | Execute the DataFrame computation and return a dictionary of column arrays.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results are
materialized into a Python dictionary where each column becomes a list of values.
Returns:
Dict[... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 314 | 326 | null | Dict[str, List[Any]] | [
"self"
] | DataFrame | null | null | Type: method
Member Name: to_pydict
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.to_pydict
Docstring: Execute the DataFrame computation and return a dictionary of column arrays.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the ... |
method | to_pylist | fenic.api.dataframe.dataframe.DataFrame.to_pylist | Execute the DataFrame computation and return a list of row dictionaries.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the results are
materialized into a Python list where each element is a dictionary
representing one row with column name... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 328 | 343 | null | List[Dict[str, Any]] | [
"self"
] | DataFrame | null | null | Type: method
Member Name: to_pylist
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.to_pylist
Docstring: Execute the DataFrame computation and return a list of row dictionaries.
This is an action that triggers computation of the DataFrame query plan.
All transformations and operations are executed, and the res... |
method | count | fenic.api.dataframe.dataframe.DataFrame.count | Count the number of rows in the DataFrame.
This is an action that triggers computation of the DataFrame.
The output is an integer representing the number of rows.
Returns:
int: The number of rows in the DataFrame | site-packages/fenic/api/dataframe/dataframe.py | true | false | 345 | 354 | null | int | [
"self"
] | DataFrame | null | null | Type: method
Member Name: count
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.count
Docstring: Count the number of rows in the DataFrame.
This is an action that triggers computation of the DataFrame.
The output is an integer representing the number of rows.
Returns:
int: The number of rows in the DataFr... |
method | lineage | fenic.api.dataframe.dataframe.DataFrame.lineage | Create a Lineage object to trace data through transformations.
The Lineage interface allows you to trace how specific rows are transformed
through your DataFrame operations, both forwards and backwards through the
computation graph.
Returns:
Lineage: Interface for querying data lineage
Example:
```python
... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 356 | 381 | null | Lineage | [
"self"
] | DataFrame | null | null | Type: method
Member Name: lineage
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.lineage
Docstring: Create a Lineage object to trace data through transformations.
The Lineage interface allows you to trace how specific rows are transformed
through your DataFrame operations, both forwards and backwards through ... |
method | persist | fenic.api.dataframe.dataframe.DataFrame.persist | Mark this DataFrame to be persisted after first computation.
The persisted DataFrame will be cached after its first computation,
avoiding recomputation in subsequent operations. This is useful for DataFrames
that are reused multiple times in your workflow.
Returns:
DataFrame: Same DataFrame, but marked for persis... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 383 | 411 | null | DataFrame | [
"self"
] | DataFrame | null | null | Type: method
Member Name: persist
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.persist
Docstring: Mark this DataFrame to be persisted after first computation.
The persisted DataFrame will be cached after its first computation,
avoiding recomputation in subsequent operations. This is useful for DataFrames
th... |
method | cache | fenic.api.dataframe.dataframe.DataFrame.cache | Alias for persist(). Mark DataFrame for caching after first computation.
Returns:
DataFrame: Same DataFrame, but marked for caching
See Also:
persist(): Full documentation of caching behavior | site-packages/fenic/api/dataframe/dataframe.py | true | false | 413 | 422 | null | DataFrame | [
"self"
] | DataFrame | null | null | Type: method
Member Name: cache
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.cache
Docstring: Alias for persist(). Mark DataFrame for caching after first computation.
Returns:
DataFrame: Same DataFrame, but marked for caching
See Also:
persist(): Full documentation of caching behavior
Value: none
A... |
method | select | fenic.api.dataframe.dataframe.DataFrame.select | Projects a set of Column expressions or column names.
Args:
*cols: Column expressions to select. Can be:
- String column names (e.g., "id", "name")
- Column objects (e.g., col("id"), col("age") + 1)
Returns:
DataFrame: A new DataFrame with selected columns
Example: Select by column names
... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 424 | 492 | null | DataFrame | [
"self",
"cols"
] | DataFrame | null | null | Type: method
Member Name: select
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.select
Docstring: Projects a set of Column expressions or column names.
Args:
*cols: Column expressions to select. Can be:
- String column names (e.g., "id", "name")
- Column objects (e.g., col("id"), col("age"... |
method | where | fenic.api.dataframe.dataframe.DataFrame.where | Filters rows using the given condition (alias for filter()).
Args:
condition: A Column expression that evaluates to a boolean
Returns:
DataFrame: Filtered DataFrame
See Also:
filter(): Full documentation of filtering behavior | site-packages/fenic/api/dataframe/dataframe.py | true | false | 494 | 506 | null | DataFrame | [
"self",
"condition"
] | DataFrame | null | null | Type: method
Member Name: where
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.where
Docstring: Filters rows using the given condition (alias for filter()).
Args:
condition: A Column expression that evaluates to a boolean
Returns:
DataFrame: Filtered DataFrame
See Also:
filter(): Full documentat... |
method | filter | fenic.api.dataframe.dataframe.DataFrame.filter | Filters rows using the given condition.
Args:
condition: A Column expression that evaluates to a boolean
Returns:
DataFrame: Filtered DataFrame
Example: Filter with numeric comparison
```python
# Create a DataFrame
df = session.create_dataframe({"age": [25, 30, 35], "name": ["Alice", "Bob", "Char... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 508 | 562 | null | DataFrame | [
"self",
"condition"
] | DataFrame | null | null | Type: method
Member Name: filter
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.filter
Docstring: Filters rows using the given condition.
Args:
condition: A Column expression that evaluates to a boolean
Returns:
DataFrame: Filtered DataFrame
Example: Filter with numeric comparison
```python
... |
method | with_column | fenic.api.dataframe.dataframe.DataFrame.with_column | Add a new column or replace an existing column.
Args:
col_name: Name of the new column
col: Column expression or value to assign to the column. If not a Column,
it will be treated as a literal value.
Returns:
DataFrame: New DataFrame with added/replaced column
Example: Add literal column
```p... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 564 | 649 | null | DataFrame | [
"self",
"col_name",
"col"
] | DataFrame | null | null | Type: method
Member Name: with_column
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.with_column
Docstring: Add a new column or replace an existing column.
Args:
col_name: Name of the new column
col: Column expression or value to assign to the column. If not a Column,
it will be treated as a l... |
method | with_column_renamed | fenic.api.dataframe.dataframe.DataFrame.with_column_renamed | Rename a column. No-op if the column does not exist.
Args:
col_name: Name of the column to rename.
new_col_name: New name for the column.
Returns:
DataFrame: New DataFrame with the column renamed.
Example: Rename a column
```python
# Create sample DataFrame
df = session.create_dataframe({
... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 651 | 715 | null | DataFrame | [
"self",
"col_name",
"new_col_name"
] | DataFrame | null | null | Type: method
Member Name: with_column_renamed
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.with_column_renamed
Docstring: Rename a column. No-op if the column does not exist.
Args:
col_name: Name of the column to rename.
new_col_name: New name for the column.
Returns:
DataFrame: New DataFrame w... |
method | drop | fenic.api.dataframe.dataframe.DataFrame.drop | Remove one or more columns from this DataFrame.
Args:
*col_names: Names of columns to drop.
Returns:
DataFrame: New DataFrame without specified columns.
Raises:
ValueError: If any specified column doesn't exist in the DataFrame.
ValueError: If dropping the columns would result in an empty DataFrame.
... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 717 | 797 | null | DataFrame | [
"self",
"col_names"
] | DataFrame | null | null | Type: method
Member Name: drop
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.drop
Docstring: Remove one or more columns from this DataFrame.
Args:
*col_names: Names of columns to drop.
Returns:
DataFrame: New DataFrame without specified columns.
Raises:
ValueError: If any specified column doesn... |
method | union | fenic.api.dataframe.dataframe.DataFrame.union | Return a new DataFrame containing the union of rows in this and another DataFrame.
This is equivalent to UNION ALL in SQL. To remove duplicates, use drop_duplicates() after union().
Args:
other: Another DataFrame with the same schema.
Returns:
DataFrame: A new DataFrame containing rows from both DataFrames.
... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 799 | 879 | null | DataFrame | [
"self",
"other"
] | DataFrame | null | null | Type: method
Member Name: union
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.union
Docstring: Return a new DataFrame containing the union of rows in this and another DataFrame.
This is equivalent to UNION ALL in SQL. To remove duplicates, use drop_duplicates() after union().
Args:
other: Another DataFr... |
method | limit | fenic.api.dataframe.dataframe.DataFrame.limit | Limits the number of rows to the specified number.
Args:
n: Maximum number of rows to return.
Returns:
DataFrame: DataFrame with at most n rows.
Raises:
TypeError: If n is not an integer.
Example: Limit rows
```python
# Create sample DataFrame
df = session.create_dataframe({
"id": [1... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 881 | 928 | null | DataFrame | [
"self",
"n"
] | DataFrame | null | null | Type: method
Member Name: limit
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.limit
Docstring: Limits the number of rows to the specified number.
Args:
n: Maximum number of rows to return.
Returns:
DataFrame: DataFrame with at most n rows.
Raises:
TypeError: If n is not an integer.
Example: Li... |
method | join | fenic.api.dataframe.dataframe.DataFrame.join | Joins this DataFrame with another DataFrame.
The Dataframes must have no duplicate column names between them. This API only supports equi-joins.
For non-equi-joins, use session.sql().
Args:
other: DataFrame to join with.
on: Join condition(s). Can be:
- A column name (str)
- A list of column n... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 949 | 1,066 | null | DataFrame | [
"self",
"other",
"on",
"left_on",
"right_on",
"how"
] | DataFrame | null | null | Type: method
Member Name: join
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.join
Docstring: Joins this DataFrame with another DataFrame.
The Dataframes must have no duplicate column names between them. This API only supports equi-joins.
For non-equi-joins, use session.sql().
Args:
other: DataFrame to j... |
method | explode | fenic.api.dataframe.dataframe.DataFrame.explode | Create a new row for each element in an array column.
This operation is useful for flattening nested data structures. For each row in the
input DataFrame that contains an array/list in the specified column, this method will:
1. Create N new rows, where N is the length of the array
2. Each new row will be identical to ... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 1,068 | 1,125 | null | DataFrame | [
"self",
"column"
] | DataFrame | null | null | Type: method
Member Name: explode
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.explode
Docstring: Create a new row for each element in an array column.
This operation is useful for flattening nested data structures. For each row in the
input DataFrame that contains an array/list in the specified column, thi... |
method | group_by | fenic.api.dataframe.dataframe.DataFrame.group_by | Groups the DataFrame using the specified columns.
Args:
*cols: Columns to group by. Can be column names as strings or Column expressions.
Returns:
GroupedData: Object for performing aggregations on the grouped data.
Example: Group by single column
```python
# Create sample DataFrame
df = session.... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 1,127 | 1,181 | null | GroupedData | [
"self",
"cols"
] | DataFrame | null | null | Type: method
Member Name: group_by
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.group_by
Docstring: Groups the DataFrame using the specified columns.
Args:
*cols: Columns to group by. Can be column names as strings or Column expressions.
Returns:
GroupedData: Object for performing aggregations on t... |
method | agg | fenic.api.dataframe.dataframe.DataFrame.agg | Aggregate on the entire DataFrame without groups.
This is equivalent to group_by() without any grouping columns.
Args:
*exprs: Aggregation expressions or dictionary of aggregations.
Returns:
DataFrame: Aggregation results.
Example: Multiple aggregations
```python
# Create sample DataFrame
df = s... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 1,183 | 1,227 | null | DataFrame | [
"self",
"exprs"
] | DataFrame | null | null | Type: method
Member Name: agg
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.agg
Docstring: Aggregate on the entire DataFrame without groups.
This is equivalent to group_by() without any grouping columns.
Args:
*exprs: Aggregation expressions or dictionary of aggregations.
Returns:
DataFrame: Aggreg... |
method | drop_duplicates | fenic.api.dataframe.dataframe.DataFrame.drop_duplicates | Return a DataFrame with duplicate rows removed.
Args:
subset: Column names to consider when identifying duplicates. If not provided, all columns are considered.
Returns:
DataFrame: A new DataFrame with duplicate rows removed.
Raises:
ValueError: If a specified column is not present in the current DataFra... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 1,229 | 1,286 | null | DataFrame | [
"self",
"subset"
] | DataFrame | null | null | Type: method
Member Name: drop_duplicates
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.drop_duplicates
Docstring: Return a DataFrame with duplicate rows removed.
Args:
subset: Column names to consider when identifying duplicates. If not provided, all columns are considered.
Returns:
DataFrame: A ne... |
method | sort | fenic.api.dataframe.dataframe.DataFrame.sort | Sort the DataFrame by the specified columns.
Args:
cols: Columns to sort by. This can be:
- A single column name (str)
- A Column expression (e.g., `col("name")`)
- A list of column names or Column expressions
- Column expressions may include sorting directives such as `asc("col")`,... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 1,288 | 1,450 | null | DataFrame | [
"self",
"cols",
"ascending"
] | DataFrame | null | null | Type: method
Member Name: sort
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.sort
Docstring: Sort the DataFrame by the specified columns.
Args:
cols: Columns to sort by. This can be:
- A single column name (str)
- A Column expression (e.g., `col("name")`)
- A list of column names ... |
method | order_by | fenic.api.dataframe.dataframe.DataFrame.order_by | Sort the DataFrame by the specified columns. Alias for sort().
Returns:
DataFrame: sorted Dataframe.
See Also:
sort(): Full documentation of sorting behavior and parameters. | site-packages/fenic/api/dataframe/dataframe.py | true | false | 1,452 | 1,465 | null | DataFrame | [
"self",
"cols",
"ascending"
] | DataFrame | null | null | Type: method
Member Name: order_by
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.order_by
Docstring: Sort the DataFrame by the specified columns. Alias for sort().
Returns:
DataFrame: sorted Dataframe.
See Also:
sort(): Full documentation of sorting behavior and parameters.
Value: none
Annotation: n... |
method | unnest | fenic.api.dataframe.dataframe.DataFrame.unnest | Unnest the specified struct columns into separate columns.
This operation flattens nested struct data by expanding each field of a struct
into its own top-level column.
For each specified column containing a struct:
1. Each field in the struct becomes a separate column.
2. New columns are named after the correspondin... | site-packages/fenic/api/dataframe/dataframe.py | true | false | 1,467 | 1,541 | null | DataFrame | [
"self",
"col_names"
] | DataFrame | null | null | Type: method
Member Name: unnest
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.unnest
Docstring: Unnest the specified struct columns into separate columns.
This operation flattens nested struct data by expanding each field of a struct
into its own top-level column.
For each specified column containing a str... |
method | _ensure_same_session | fenic.api.dataframe.dataframe.DataFrame._ensure_same_session | Ensure that any session context passed are from the same session context.
This check prevents accidental combinations of DataFrames created in different
sessions, which can lead to inconsistent behavior due to differing configurations,
catalogs, or function registries. | site-packages/fenic/api/dataframe/dataframe.py | false | true | 1,543 | 1,560 | null | null | [
"cls",
"session_state",
"other_session_states"
] | DataFrame | null | null | Type: method
Member Name: _ensure_same_session
Qualified Name: fenic.api.dataframe.dataframe.DataFrame._ensure_same_session
Docstring: Ensure that any session context passed are from the same session context.
This check prevents accidental combinations of DataFrames created in different
sessions, which can lead to inc... |
module | grouped_data | fenic.api.dataframe.grouped_data | GroupedData class for aggregations on grouped DataFrames. | site-packages/fenic/api/dataframe/grouped_data.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: grouped_data
Qualified Name: fenic.api.dataframe.grouped_data
Docstring: GroupedData class for aggregations on grouped DataFrames.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | GroupedData | fenic.api.dataframe.grouped_data.GroupedData | Methods for aggregations on a grouped DataFrame. | site-packages/fenic/api/dataframe/grouped_data.py | true | false | 19 | 94 | null | null | null | null | null | [
"BaseGroupedData"
] | Type: class
Member Name: GroupedData
Qualified Name: fenic.api.dataframe.grouped_data.GroupedData
Docstring: Methods for aggregations on a grouped DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.api.dataframe.grouped_data.GroupedData.__init__ | Initialize grouped data.
Args:
df: The DataFrame to group.
by: Optional list of columns to group by. | site-packages/fenic/api/dataframe/grouped_data.py | true | false | 22 | 43 | null | null | [
"self",
"df",
"by"
] | GroupedData | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.api.dataframe.grouped_data.GroupedData.__init__
Docstring: Initialize grouped data.
Args:
df: The DataFrame to group.
by: Optional list of columns to group by.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "df", ... |
method | agg | fenic.api.dataframe.grouped_data.GroupedData.agg | Compute aggregations on grouped data and return the result as a DataFrame.
This method applies aggregate functions to the grouped data.
Args:
*exprs: Aggregation expressions. Can be:
- Column expressions with aggregate functions (e.g., `count("*")`, `sum("amount")`)
- A dictionary mapping column ... | site-packages/fenic/api/dataframe/grouped_data.py | true | false | 45 | 94 | null | DataFrame | [
"self",
"exprs"
] | GroupedData | null | null | Type: method
Member Name: agg
Qualified Name: fenic.api.dataframe.grouped_data.GroupedData.agg
Docstring: Compute aggregations on grouped data and return the result as a DataFrame.
This method applies aggregate functions to the grouped data.
Args:
*exprs: Aggregation expressions. Can be:
- Column express... |
module | _join_utils | fenic.api.dataframe._join_utils | Utility functions for DataFrame join operations. | site-packages/fenic/api/dataframe/_join_utils.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _join_utils
Qualified Name: fenic.api.dataframe._join_utils
Docstring: Utility functions for DataFrame join operations.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
function | validate_join_parameters | fenic.api.dataframe._join_utils.validate_join_parameters | Validate join parameter combinations. | site-packages/fenic/api/dataframe/_join_utils.py | true | false | 10 | 51 | null | None | [
"self",
"on",
"left_on",
"right_on",
"how"
] | null | null | null | Type: function
Member Name: validate_join_parameters
Qualified Name: fenic.api.dataframe._join_utils.validate_join_parameters
Docstring: Validate join parameter combinations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "on", "left_on", "right_on", "how"]
Returns: None
Parent ... |
function | build_join_conditions | fenic.api.dataframe._join_utils.build_join_conditions | Build left and right join condition lists. | site-packages/fenic/api/dataframe/_join_utils.py | true | false | 53 | 82 | null | Tuple[List, List] | [
"on",
"left_on",
"right_on"
] | null | null | null | Type: function
Member Name: build_join_conditions
Qualified Name: fenic.api.dataframe._join_utils.build_join_conditions
Docstring: Build left and right join condition lists.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["on", "left_on", "right_on"]
Returns: Tuple[List, List]
Parent Cla... |
function | _has_join_conditions | fenic.api.dataframe._join_utils._has_join_conditions | Check if any join conditions are specified. | site-packages/fenic/api/dataframe/_join_utils.py | false | true | 84 | 94 | null | bool | [
"on",
"left_on",
"right_on"
] | null | null | null | Type: function
Member Name: _has_join_conditions
Qualified Name: fenic.api.dataframe._join_utils._has_join_conditions
Docstring: Check if any join conditions are specified.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["on", "left_on", "right_on"]
Returns: bool
Parent Class: none |
function | _validate_join_condition_lengths | fenic.api.dataframe._join_utils._validate_join_condition_lengths | Validate that left_on and right_on have matching lengths. | site-packages/fenic/api/dataframe/_join_utils.py | false | true | 96 | 108 | null | None | [
"left_on",
"right_on"
] | null | null | null | Type: function
Member Name: _validate_join_condition_lengths
Qualified Name: fenic.api.dataframe._join_utils._validate_join_condition_lengths
Docstring: Validate that left_on and right_on have matching lengths.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["left_on", "right_on"]
Return... |
module | semantic_extensions | fenic.api.dataframe.semantic_extensions | Semantic extensions for DataFrames providing clustering and semantic join operations. | site-packages/fenic/api/dataframe/semantic_extensions.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: semantic_extensions
Qualified Name: fenic.api.dataframe.semantic_extensions
Docstring: Semantic extensions for DataFrames providing clustering and semantic join operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | SemanticExtensions | fenic.api.dataframe.semantic_extensions.SemanticExtensions | A namespace for semantic dataframe operators. | site-packages/fenic/api/dataframe/semantic_extensions.py | true | false | 26 | 368 | null | null | null | null | null | [] | Type: class
Member Name: SemanticExtensions
Qualified Name: fenic.api.dataframe.semantic_extensions.SemanticExtensions
Docstring: A namespace for semantic dataframe operators.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.api.dataframe.semantic_extensions.SemanticExtensions.__init__ | Initialize semantic extensions.
Args:
df: The DataFrame to extend with semantic operations. | site-packages/fenic/api/dataframe/semantic_extensions.py | true | false | 29 | 35 | null | null | [
"self",
"df"
] | SemanticExtensions | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.api.dataframe.semantic_extensions.SemanticExtensions.__init__
Docstring: Initialize semantic extensions.
Args:
df: The DataFrame to extend with semantic operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "df"]... |
method | with_cluster_labels | fenic.api.dataframe.semantic_extensions.SemanticExtensions.with_cluster_labels | Cluster rows using K-means and add cluster metadata columns.
This method clusters rows based on the given embedding column or expression using K-means.
It adds a new column with cluster assignments, and optionally includes the centroid embedding
for each assigned cluster.
Args:
by: Column or expression producing ... | site-packages/fenic/api/dataframe/semantic_extensions.py | true | false | 37 | 130 | null | DataFrame | [
"self",
"by",
"num_clusters",
"max_iter",
"num_init",
"label_column",
"centroid_column"
] | SemanticExtensions | null | null | Type: method
Member Name: with_cluster_labels
Qualified Name: fenic.api.dataframe.semantic_extensions.SemanticExtensions.with_cluster_labels
Docstring: Cluster rows using K-means and add cluster metadata columns.
This method clusters rows based on the given embedding column or expression using K-means.
It adds a new c... |
method | join | fenic.api.dataframe.semantic_extensions.SemanticExtensions.join | Performs a semantic join between two DataFrames using a natural language predicate.
This method evaluates a boolean predicate for each potential row pair between the two DataFrames,
including only those pairs where the predicate evaluates to True.
The join process:
1. For each row in the left DataFrame, evaluates the... | site-packages/fenic/api/dataframe/semantic_extensions.py | true | false | 132 | 251 | null | DataFrame | [
"self",
"other",
"predicate",
"left_on",
"right_on",
"strict",
"examples",
"model_alias"
] | SemanticExtensions | null | null | Type: method
Member Name: join
Qualified Name: fenic.api.dataframe.semantic_extensions.SemanticExtensions.join
Docstring: Performs a semantic join between two DataFrames using a natural language predicate.
This method evaluates a boolean predicate for each potential row pair between the two DataFrames,
including only ... |
method | sim_join | fenic.api.dataframe.semantic_extensions.SemanticExtensions.sim_join | Performs a semantic similarity join between two DataFrames using embedding expressions.
For each row in the left DataFrame, returns the top `k` most semantically similar rows
from the right DataFrame based on the specified similarity metric.
Args:
other: The right-hand DataFrame to join with.
left_on: Express... | site-packages/fenic/api/dataframe/semantic_extensions.py | true | false | 253 | 365 | null | DataFrame | [
"self",
"other",
"left_on",
"right_on",
"k",
"similarity_metric",
"similarity_score_column"
] | SemanticExtensions | null | null | Type: method
Member Name: sim_join
Qualified Name: fenic.api.dataframe.semantic_extensions.SemanticExtensions.sim_join
Docstring: Performs a semantic similarity join between two DataFrames using embedding expressions.
For each row in the left DataFrame, returns the top `k` most semantically similar rows
from the right... |
module | io | fenic.api.io | IO module for reading and writing DataFrames to external storage. | site-packages/fenic/api/io/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: io
Qualified Name: fenic.api.io
Docstring: IO module for reading and writing DataFrames to external storage.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.api.io.__all__ | null | site-packages/fenic/api/io/__init__.py | false | false | 6 | 6 | null | null | null | null | ['DataFrameReader', 'DataFrameWriter'] | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.api.io.__all__
Docstring: none
Value: ['DataFrameReader', 'DataFrameWriter']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | reader | fenic.api.io.reader | Reader interface for loading DataFrames from external storage systems. | site-packages/fenic/api/io/reader.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: reader
Qualified Name: fenic.api.io.reader
Docstring: Reader interface for loading DataFrames from external storage systems.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | DataFrameReader | fenic.api.io.reader.DataFrameReader | Interface used to load a DataFrame from external storage systems.
Similar to PySpark's DataFrameReader.
Supported External Storage Schemes:
- Amazon S3 (s3://)
- Format: s3://{bucket_name}/{path_to_file}
- Notes:
- Uses boto3 to aquire AWS credentials.
- Examples:
- s3://my-bucket/data.c... | site-packages/fenic/api/io/reader.py | true | false | 21 | 335 | null | null | null | null | null | [] | Type: class
Member Name: DataFrameReader
Qualified Name: fenic.api.io.reader.DataFrameReader
Docstring: Interface used to load a DataFrame from external storage systems.
Similar to PySpark's DataFrameReader.
Supported External Storage Schemes:
- Amazon S3 (s3://)
- Format: s3://{bucket_name}/{path_to_file}
-... |
method | __init__ | fenic.api.io.reader.DataFrameReader.__init__ | Creates a DataFrameReader.
Args:
session_state: The session state to use for reading | site-packages/fenic/api/io/reader.py | true | false | 60 | 67 | null | null | [
"self",
"session_state"
] | DataFrameReader | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.api.io.reader.DataFrameReader.__init__
Docstring: Creates a DataFrameReader.
Args:
session_state: The session state to use for reading
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "session_state"]
Returns: none
Pare... |
method | csv | fenic.api.io.reader.DataFrameReader.csv | Load a DataFrame from one or more CSV files.
Args:
paths: A single file path, a glob pattern (e.g., "data/*.csv"), or a list of paths.
schema: (optional) A complete schema definition of column names and their types. Only primitive types are supported.
- For e.g.:
- Schema([ColumnField(name=... | site-packages/fenic/api/io/reader.py | true | false | 69 | 151 | null | DataFrame | [
"self",
"paths",
"schema",
"merge_schemas"
] | DataFrameReader | null | null | Type: method
Member Name: csv
Qualified Name: fenic.api.io.reader.DataFrameReader.csv
Docstring: Load a DataFrame from one or more CSV files.
Args:
paths: A single file path, a glob pattern (e.g., "data/*.csv"), or a list of paths.
schema: (optional) A complete schema definition of column names and their types... |
method | parquet | fenic.api.io.reader.DataFrameReader.parquet | Load a DataFrame from one or more Parquet files.
Args:
paths: A single file path, a glob pattern (e.g., "data/*.parquet"), or a list of paths.
merge_schemas: If True, infers and merges schemas across all files.
Missing columns are filled with nulls, and differing types are widened to a common supertype... | site-packages/fenic/api/io/reader.py | true | false | 153 | 202 | null | DataFrame | [
"self",
"paths",
"merge_schemas"
] | DataFrameReader | null | null | Type: method
Member Name: parquet
Qualified Name: fenic.api.io.reader.DataFrameReader.parquet
Docstring: Load a DataFrame from one or more Parquet files.
Args:
paths: A single file path, a glob pattern (e.g., "data/*.parquet"), or a list of paths.
merge_schemas: If True, infers and merges schemas across all fi... |
method | _read_file | fenic.api.io.reader.DataFrameReader._read_file | Internal helper method to read files of a specific format.
Args:
paths: Path(s) to the file(s). Can be a single path or a list of paths.
file_format: Format of the file (e.g., "csv", "parquet").
file_extension: Expected file extension (e.g., ".csv", ".parquet").
**options: Additional options to pass to... | site-packages/fenic/api/io/reader.py | false | true | 204 | 264 | null | DataFrame | [
"self",
"paths",
"file_format",
"file_extension",
"options"
] | DataFrameReader | null | null | Type: method
Member Name: _read_file
Qualified Name: fenic.api.io.reader.DataFrameReader._read_file
Docstring: Internal helper method to read files of a specific format.
Args:
paths: Path(s) to the file(s). Can be a single path or a list of paths.
file_format: Format of the file (e.g., "csv", "parquet").
f... |
method | docs | fenic.api.io.reader.DataFrameReader.docs | Load a DataFrame from a list of paths of documents (markdown or json).
Args:
paths: Glob pattern (or list of glob patterns) to the folder(s) to load.
data_type: Data type that will be used to cast the content of the files.
One of MarkdownType or JsonType.
exclude: A regex pattern to exclude ... | site-packages/fenic/api/io/reader.py | true | false | 266 | 335 | null | DataFrame | [
"self",
"paths",
"data_type",
"exclude",
"recursive"
] | DataFrameReader | null | null | Type: method
Member Name: docs
Qualified Name: fenic.api.io.reader.DataFrameReader.docs
Docstring: Load a DataFrame from a list of paths of documents (markdown or json).
Args:
paths: Glob pattern (or list of glob patterns) to the folder(s) to load.
data_type: Data type that will be used to cast the content of ... |
module | writer | fenic.api.io.writer | Writer interface for saving DataFrames to external storage systems. | site-packages/fenic/api/io/writer.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: writer
Qualified Name: fenic.api.io.writer
Docstring: Writer interface for saving DataFrames to external storage systems.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | logger | fenic.api.io.writer.logger | null | site-packages/fenic/api/io/writer.py | true | false | 18 | 18 | null | null | null | null | logging.getLogger(__name__) | null | Type: attribute
Member Name: logger
Qualified Name: fenic.api.io.writer.logger
Docstring: none
Value: logging.getLogger(__name__)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | DataFrameWriter | fenic.api.io.writer.DataFrameWriter | Interface used to write a DataFrame to external storage systems.
Similar to PySpark's DataFrameWriter.
Supported External Storage Schemes:
- Amazon S3 (s3://)
- Format: s3://{bucket_name}/{path_to_file}
- Notes:
- Uses boto3 to aquire AWS credentials.
- Examples:
- s3://my-bucket/data.cs... | site-packages/fenic/api/io/writer.py | true | false | 21 | 223 | null | null | null | null | null | [] | Type: class
Member Name: DataFrameWriter
Qualified Name: fenic.api.io.writer.DataFrameWriter
Docstring: Interface used to write a DataFrame to external storage systems.
Similar to PySpark's DataFrameWriter.
Supported External Storage Schemes:
- Amazon S3 (s3://)
- Format: s3://{bucket_name}/{path_to_file}
- ... |
method | __init__ | fenic.api.io.writer.DataFrameWriter.__init__ | Initialize a DataFrameWriter.
Args:
dataframe: The DataFrame to write. | site-packages/fenic/api/io/writer.py | true | false | 47 | 53 | null | null | [
"self",
"dataframe"
] | DataFrameWriter | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.api.io.writer.DataFrameWriter.__init__
Docstring: Initialize a DataFrameWriter.
Args:
dataframe: The DataFrame to write.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "dataframe"]
Returns: none
Parent Class: DataFram... |
method | save_as_table | fenic.api.io.writer.DataFrameWriter.save_as_table | Saves the content of the DataFrame as the specified table.
Args:
table_name: Name of the table to save to
mode: Write mode. Default is "error".
- error: Raises an error if table exists
- append: Appends data to table if it exists
- overwrite: Overwrites existing table
- igno... | site-packages/fenic/api/io/writer.py | true | false | 55 | 99 | null | QueryMetrics | [
"self",
"table_name",
"mode"
] | DataFrameWriter | null | null | Type: method
Member Name: save_as_table
Qualified Name: fenic.api.io.writer.DataFrameWriter.save_as_table
Docstring: Saves the content of the DataFrame as the specified table.
Args:
table_name: Name of the table to save to
mode: Write mode. Default is "error".
- error: Raises an error if table exists
... |
method | save_as_view | fenic.api.io.writer.DataFrameWriter.save_as_view | Saves the content of the DataFrame as a view.
Args:
view_name: Name of the view to save to
description: Optional human-readable view description to store in the catalog.
Returns:
None. | site-packages/fenic/api/io/writer.py | true | false | 101 | 117 | null | None | [
"self",
"view_name",
"description"
] | DataFrameWriter | null | null | Type: method
Member Name: save_as_view
Qualified Name: fenic.api.io.writer.DataFrameWriter.save_as_view
Docstring: Saves the content of the DataFrame as a view.
Args:
view_name: Name of the view to save to
description: Optional human-readable view description to store in the catalog.
Returns:
None.
Value:... |
method | csv | fenic.api.io.writer.DataFrameWriter.csv | Saves the content of the DataFrame as a single CSV file with comma as the delimiter and headers in the first row.
Args:
file_path: Path to save the CSV file to
mode: Write mode. Default is "overwrite".
- error: Raises an error if file exists
- overwrite: Overwrites the file if it exists
... | site-packages/fenic/api/io/writer.py | true | false | 119 | 170 | null | QueryMetrics | [
"self",
"file_path",
"mode"
] | DataFrameWriter | null | null | Type: method
Member Name: csv
Qualified Name: fenic.api.io.writer.DataFrameWriter.csv
Docstring: Saves the content of the DataFrame as a single CSV file with comma as the delimiter and headers in the first row.
Args:
file_path: Path to save the CSV file to
mode: Write mode. Default is "overwrite".
- e... |
method | parquet | fenic.api.io.writer.DataFrameWriter.parquet | Saves the content of the DataFrame as a single Parquet file.
Args:
file_path: Path to save the Parquet file to
mode: Write mode. Default is "overwrite".
- error: Raises an error if file exists
- overwrite: Overwrites the file if it exists
- ignore: Silently ignores operation if file ... | site-packages/fenic/api/io/writer.py | true | false | 172 | 223 | null | QueryMetrics | [
"self",
"file_path",
"mode"
] | DataFrameWriter | null | null | Type: method
Member Name: parquet
Qualified Name: fenic.api.io.writer.DataFrameWriter.parquet
Docstring: Saves the content of the DataFrame as a single Parquet file.
Args:
file_path: Path to save the Parquet file to
mode: Write mode. Default is "overwrite".
- error: Raises an error if file exists
... |
module | mcp | fenic.api.mcp | MCP Tool Creation/Server Management API. | site-packages/fenic/api/mcp/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: mcp
Qualified Name: fenic.api.mcp
Docstring: MCP Tool Creation/Server Management API.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.api.mcp.__all__ | null | site-packages/fenic/api/mcp/__init__.py | false | false | 10 | 15 | null | null | null | null | ['create_mcp_server', 'run_mcp_server_sync', 'run_mcp_server_async', 'run_mcp_server_asgi'] | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.api.mcp.__all__
Docstring: none
Value: ['create_mcp_server', 'run_mcp_server_sync', 'run_mcp_server_async', 'run_mcp_server_asgi']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | server | fenic.api.mcp.server | Create MCP servers using Fenic DataFrames.
This module exposes helpers to:
- Build a Fenic-backed MCP server from datasets and tools
- Run the server synchronously or asynchronously | site-packages/fenic/api/mcp/server.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: server
Qualified Name: fenic.api.mcp.server
Docstring: Create MCP servers using Fenic DataFrames.
This module exposes helpers to:
- Build a Fenic-backed MCP server from datasets and tools
- Run the server synchronously or asynchronously
Value: none
Annotation: none
is Public? : true
is Privat... |
function | create_mcp_server | fenic.api.mcp.server.create_mcp_server | Create an MCP server from datasets and tools.
Args:
session: Fenic session used to execute tools.
server_name: Name of the MCP server.
tools: Tools to register (optional).
concurrency_limit: Maximum number of concurrent tool executions. | site-packages/fenic/api/mcp/server.py | true | false | 15 | 34 | null | FenicMCPServer | [
"session",
"server_name",
"tools",
"concurrency_limit"
] | null | null | null | Type: function
Member Name: create_mcp_server
Qualified Name: fenic.api.mcp.server.create_mcp_server
Docstring: Create an MCP server from datasets and tools.
Args:
session: Fenic session used to execute tools.
server_name: Name of the MCP server.
tools: Tools to register (optional).
concurrency_limit: ... |
function | run_mcp_server_asgi | fenic.api.mcp.server.run_mcp_server_asgi | Run an MCP server as a Starlette ASGI app.
Returns a Starlette ASGI app that can be integrated into any ASGI server.
This is useful for running the MCP server in a production environment, or running the MCP server as part of a larger application.
Args:
server: MCP server to run.
stateless_http: If True, use s... | site-packages/fenic/api/mcp/server.py | true | false | 36 | 62 | null | null | [
"server",
"stateless_http",
"port",
"host",
"path",
"kwargs"
] | null | null | null | Type: function
Member Name: run_mcp_server_asgi
Qualified Name: fenic.api.mcp.server.run_mcp_server_asgi
Docstring: Run an MCP server as a Starlette ASGI app.
Returns a Starlette ASGI app that can be integrated into any ASGI server.
This is useful for running the MCP server in a production environment, or running the ... |
function | run_mcp_server_sync | fenic.api.mcp.server.run_mcp_server_sync | Run an MCP server synchronously.
Use this when calling from synchronous code. This creates a new event loop and runs the server in it.
Args:
server: MCP server to run.
transport: Transport protocol (http, stdio).
stateless_http: If True, use stateless HTTP.
port: Port to listen on.
host: Host to l... | site-packages/fenic/api/mcp/server.py | true | false | 64 | 87 | null | null | [
"server",
"transport",
"stateless_http",
"port",
"host",
"path",
"kwargs"
] | null | null | null | Type: function
Member Name: run_mcp_server_sync
Qualified Name: fenic.api.mcp.server.run_mcp_server_sync
Docstring: Run an MCP server synchronously.
Use this when calling from synchronous code. This creates a new event loop and runs the server in it.
Args:
server: MCP server to run.
transport: Transport proto... |
function | run_mcp_server_async | fenic.api.mcp.server.run_mcp_server_async | Run an MCP server asynchronously.
Use this when calling from asynchronous code. This does not create a new event loop.
Args:
server: MCP server to run.
transport: Transport protocol (http, stdio).
stateless_http: If True, use stateless HTTP.
port: Port to listen on.
host: Host to listen on.
pa... | site-packages/fenic/api/mcp/server.py | true | false | 90 | 113 | null | null | [
"server",
"transport",
"stateless_http",
"port",
"host",
"path",
"kwargs"
] | null | null | null | Type: function
Member Name: run_mcp_server_async
Qualified Name: fenic.api.mcp.server.run_mcp_server_async
Docstring: Run an MCP server asynchronously.
Use this when calling from asynchronous code. This does not create a new event loop.
Args:
server: MCP server to run.
transport: Transport protocol (http, std... |
module | functions | fenic.api.functions | Functions for working with DataFrame columns. | site-packages/fenic/api/functions/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: functions
Qualified Name: fenic.api.functions
Docstring: Functions for working with DataFrame columns.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.api.functions.__all__ | null | site-packages/fenic/api/functions/__init__.py | false | false | 34 | 77 | null | null | null | null | ['semantic', 'text', 'embedding', 'array', 'array_agg', 'async_udf', 'avg', 'collect_list', 'coalesce', 'count', 'json', 'markdown', 'max', 'mean', 'min', 'struct', 'sum', 'udf', 'col', 'lit', 'array_size', 'array_contains', 'asc', 'asc_nulls_first', 'asc_nulls_last', 'desc', 'desc_nulls_first', 'desc_nulls_last', 'ext... | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.api.functions.__all__
Docstring: none
Value: ['semantic', 'text', 'embedding', 'array', 'array_agg', 'async_udf', 'avg', 'collect_list', 'coalesce', 'count', 'json', 'markdown', 'max', 'mean', 'min', 'struct', 'sum', 'udf', 'col', 'lit', 'array_size', 'array_co... |
module | semantic | fenic.api.functions.semantic | Semantic functions for Fenic DataFrames - LLM-based operations. | site-packages/fenic/api/functions/semantic.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: semantic
Qualified Name: fenic.api.functions.semantic
Docstring: Semantic functions for Fenic DataFrames - LLM-based operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
function | map | fenic.api.functions.semantic.map | Applies a generation prompt to one or more columns, enabling rich summarization and generation tasks.
Args:
prompt: A Jinja2 template for the generation prompt. References column
values using {{ column_name }} syntax. Each placeholder is replaced with the
corresponding value from the current row du... | site-packages/fenic/api/functions/semantic.py | true | false | 38 | 136 | null | Column | [
"prompt",
"strict",
"examples",
"response_format",
"model_alias",
"temperature",
"max_output_tokens",
"columns"
] | null | null | null | Type: function
Member Name: map
Qualified Name: fenic.api.functions.semantic.map
Docstring: Applies a generation prompt to one or more columns, enabling rich summarization and generation tasks.
Args:
prompt: A Jinja2 template for the generation prompt. References column
values using {{ column_name }} synta... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.