type stringclasses 5
values | name stringlengths 1 55 | qualified_name stringlengths 5 147 | docstring stringlengths 15 4.52k ⌀ | filepath stringclasses 206
values | is_public bool 2
classes | is_private bool 2
classes | line_start int64 0 1.99k ⌀ | line_end int64 0 2.01k ⌀ | annotation stringclasses 14
values | returns stringclasses 308
values | value stringclasses 152
values | parameters listlengths 0 117 ⌀ | bases listlengths 0 3 ⌀ | parent_class stringclasses 376
values | api_element_summary stringlengths 199 33.8k |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
method | alias | fenic.api.column.Column.alias | Create an alias for this column.
This method assigns a new name to the column expression, which is useful
for renaming columns or providing names for complex expressions.
Args:
name (str): The alias name to assign
Returns:
Column: Column with the specified alias
Example: Rename a column
```python
# ... | null | true | false | 171 | 195 | null | Column | null | [
"self",
"name"
] | null | Column | Type: method
Member Name: alias
Qualified Name: fenic.api.column.Column.alias
Docstring: Create an alias for this column.
This method assigns a new name to the column expression, which is useful
for renaming columns or providing names for complex expressions.
Args:
name (str): The alias name to assign
Returns:
... |
method | cast | fenic.api.column.Column.cast | Cast the column to a new data type.
This method creates an expression that casts the column to a specified data type.
The casting behavior depends on the source and target types:
Primitive type casting:
- Numeric types (IntegerType, FloatType, DoubleType) can be cast between each other
- Numeric types can be cast to... | null | true | false | 197 | 251 | null | Column | null | [
"self",
"data_type"
] | null | Column | Type: method
Member Name: cast
Qualified Name: fenic.api.column.Column.cast
Docstring: Cast the column to a new data type.
This method creates an expression that casts the column to a specified data type.
The casting behavior depends on the source and target types:
Primitive type casting:
- Numeric types (IntegerTyp... |
method | desc | fenic.api.column.Column.desc | Mark this column for descending sort order.
Returns:
Column: A sort expression with descending order.
Example: Sort by age in descending order
```python
# Sort a dataframe by age in descending order
df.sort(col("age").desc()).show()
``` | null | true | false | 253 | 267 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: desc
Qualified Name: fenic.api.column.Column.desc
Docstring: Mark this column for descending sort order.
Returns:
Column: A sort expression with descending order.
Example: Sort by age in descending order
```python
# Sort a dataframe by age in descending order
df.sort(col("age... |
method | desc_nulls_first | fenic.api.column.Column.desc_nulls_first | Alias for desc().
Returns:
Column: A sort expression with descending order and nulls first.
Example: Sort by age in descending order with nulls first
```python
df.sort(col("age").desc_nulls_first()).show()
``` | null | true | false | 269 | 280 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: desc_nulls_first
Qualified Name: fenic.api.column.Column.desc_nulls_first
Docstring: Alias for desc().
Returns:
Column: A sort expression with descending order and nulls first.
Example: Sort by age in descending order with nulls first
```python
df.sort(col("age").desc_nulls_first... |
method | desc_nulls_last | fenic.api.column.Column.desc_nulls_last | Mark this column for descending sort order with nulls last.
Returns:
Column: A sort expression with descending order and nulls last.
Example: Sort by age in descending order with nulls last
```python
# Sort a dataframe by age in descending order, with nulls appearing last
df.sort(col("age").desc_nulls... | null | true | false | 282 | 296 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: desc_nulls_last
Qualified Name: fenic.api.column.Column.desc_nulls_last
Docstring: Mark this column for descending sort order with nulls last.
Returns:
Column: A sort expression with descending order and nulls last.
Example: Sort by age in descending order with nulls last
```python
... |
method | asc | fenic.api.column.Column.asc | Mark this column for ascending sort order.
Returns:
Column: A sort expression with ascending order and nulls first.
Example: Sort by age in ascending order
```python
# Sort a dataframe by age in ascending order
df.sort(col("age").asc()).show()
``` | null | true | false | 298 | 310 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: asc
Qualified Name: fenic.api.column.Column.asc
Docstring: Mark this column for ascending sort order.
Returns:
Column: A sort expression with ascending order and nulls first.
Example: Sort by age in ascending order
```python
# Sort a dataframe by age in ascending order
df.sor... |
method | asc_nulls_first | fenic.api.column.Column.asc_nulls_first | Alias for asc().
Returns:
Column: A Column expression that provides a column and sort order to the sort function | null | true | false | 312 | 318 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: asc_nulls_first
Qualified Name: fenic.api.column.Column.asc_nulls_first
Docstring: Alias for asc().
Returns:
Column: A Column expression that provides a column and sort order to the sort function
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Retur... |
method | asc_nulls_last | fenic.api.column.Column.asc_nulls_last | Mark this column for ascending sort order with nulls last.
Returns:
Column: A sort expression with ascending order and nulls last.
Example: Sort by age in ascending order with nulls last
```python
# Sort a dataframe by age in ascending order, with nulls appearing last
df.sort(col("age").asc_nulls_last... | null | true | false | 320 | 334 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: asc_nulls_last
Qualified Name: fenic.api.column.Column.asc_nulls_last
Docstring: Mark this column for ascending sort order with nulls last.
Returns:
Column: A sort expression with ascending order and nulls last.
Example: Sort by age in ascending order with nulls last
```python
# ... |
method | contains | fenic.api.column.Column.contains | Check if the column contains a substring.
This method creates a boolean expression that checks if each value in the column
contains the specified substring. The substring can be either a literal string
or a column expression.
Args:
other (Union[str, Column]): The substring to search for (can be a string or column... | null | true | false | 336 | 365 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: contains
Qualified Name: fenic.api.column.Column.contains
Docstring: Check if the column contains a substring.
This method creates a boolean expression that checks if each value in the column
contains the specified substring. The substring can be either a literal string
or a column expression... |
method | contains_any | fenic.api.column.Column.contains_any | Check if the column contains any of the specified substrings.
This method creates a boolean expression that checks if each value in the column
contains any of the specified substrings. The matching can be case-sensitive or
case-insensitive.
Args:
others (List[str]): List of substrings to search for
case_insen... | null | true | false | 367 | 395 | null | Column | null | [
"self",
"others",
"case_insensitive"
] | null | Column | Type: method
Member Name: contains_any
Qualified Name: fenic.api.column.Column.contains_any
Docstring: Check if the column contains any of the specified substrings.
This method creates a boolean expression that checks if each value in the column
contains any of the specified substrings. The matching can be case-sensit... |
method | starts_with | fenic.api.column.Column.starts_with | Check if the column starts with a substring.
This method creates a boolean expression that checks if each value in the column
starts with the specified substring. The substring can be either a literal string
or a column expression.
Args:
other (Union[str, Column]): The substring to check for at the start (can be ... | null | true | false | 397 | 431 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: starts_with
Qualified Name: fenic.api.column.Column.starts_with
Docstring: Check if the column starts with a substring.
This method creates a boolean expression that checks if each value in the column
starts with the specified substring. The substring can be either a literal string
or a colum... |
method | ends_with | fenic.api.column.Column.ends_with | Check if the column ends with a substring.
This method creates a boolean expression that checks if each value in the column
ends with the specified substring. The substring can be either a literal string
or a column expression.
Args:
other (Union[str, Column]): The substring to check for at the end (can be a stri... | null | true | false | 433 | 465 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: ends_with
Qualified Name: fenic.api.column.Column.ends_with
Docstring: Check if the column ends with a substring.
This method creates a boolean expression that checks if each value in the column
ends with the specified substring. The substring can be either a literal string
or a column expres... |
method | rlike | fenic.api.column.Column.rlike | Check if the column matches a regular expression pattern.
This method creates a boolean expression that checks if each value in the column
matches the specified regular expression pattern.
Args:
other (Union[str, Column]): The regular expression pattern to match against.
Can be a string or a a column ex... | null | true | false | 467 | 496 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: rlike
Qualified Name: fenic.api.column.Column.rlike
Docstring: Check if the column matches a regular expression pattern.
This method creates a boolean expression that checks if each value in the column
matches the specified regular expression pattern.
Args:
other (Union[str, Column]): Th... |
method | like | fenic.api.column.Column.like | Check if the column matches a SQL LIKE pattern.
This method creates a boolean expression that checks if each value in the column
matches the specified SQL LIKE pattern.
The pattern can be a string or a a column expression that resolves to a string.
SQL LIKE pattern syntax:
- % matches any sequence of characters
- _ ... | null | true | false | 498 | 532 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: like
Qualified Name: fenic.api.column.Column.like
Docstring: Check if the column matches a SQL LIKE pattern.
This method creates a boolean expression that checks if each value in the column
matches the specified SQL LIKE pattern.
The pattern can be a string or a a column expression that resol... |
method | ilike | fenic.api.column.Column.ilike | Check if the column matches a SQL LIKE pattern (case-insensitive).
This method creates a boolean expression that checks if each value in the column
matches the specified SQL LIKE pattern, ignoring case.
The pattern can be a string or a a column expression that resolves to a string.
SQL LIKE pattern syntax:
- % match... | null | true | false | 534 | 568 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: ilike
Qualified Name: fenic.api.column.Column.ilike
Docstring: Check if the column matches a SQL LIKE pattern (case-insensitive).
This method creates a boolean expression that checks if each value in the column
matches the specified SQL LIKE pattern, ignoring case.
The pattern can be a string... |
method | is_null | fenic.api.column.Column.is_null | Check if the column contains NULL values.
This method creates an expression that evaluates to TRUE when the column value is NULL.
Returns:
Column: A Column representing a boolean expression that is TRUE when this column is NULL
Example: Filter rows where a column is NULL
```python
# Filter rows where som... | null | true | false | 570 | 590 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: is_null
Qualified Name: fenic.api.column.Column.is_null
Docstring: Check if the column contains NULL values.
This method creates an expression that evaluates to TRUE when the column value is NULL.
Returns:
Column: A Column representing a boolean expression that is TRUE when this column i... |
method | is_not_null | fenic.api.column.Column.is_not_null | Check if the column contains non-NULL values.
This method creates an expression that evaluates to TRUE when the column value is not NULL.
Returns:
Column: A Column representing a boolean expression that is TRUE when this column is not NULL
Example: Filter rows where a column is not NULL
```python
df.filt... | null | true | false | 592 | 610 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: is_not_null
Qualified Name: fenic.api.column.Column.is_not_null
Docstring: Check if the column contains non-NULL values.
This method creates an expression that evaluates to TRUE when the column value is not NULL.
Returns:
Column: A Column representing a boolean expression that is TRUE wh... |
method | when | fenic.api.column.Column.when | Evaluates a condition for each row and returns a value when true.
Can be chained with more .when() calls or finished with .otherwise().
All branches must return the same type.
Args:
condition: Boolean expression to test
value: Value to return when condition is True
Returns:
Column: A new when expression ... | null | true | false | 612 | 650 | null | Column | null | [
"self",
"condition",
"value"
] | null | Column | Type: method
Member Name: when
Qualified Name: fenic.api.column.Column.when
Docstring: Evaluates a condition for each row and returns a value when true.
Can be chained with more .when() calls or finished with .otherwise().
All branches must return the same type.
Args:
condition: Boolean expression to test
val... |
method | otherwise | fenic.api.column.Column.otherwise | Returns a value when no prior conditions are True.
This is the final part of a when-chain, like the 'else' in an if-elif-else.
All branches must return the same type.
Args:
value: Value to return when no prior conditions are True
Returns:
Column: The complete conditional expression chain
Raises:
Validat... | null | true | false | 652 | 694 | null | Column | null | [
"self",
"value"
] | null | Column | Type: method
Member Name: otherwise
Qualified Name: fenic.api.column.Column.otherwise
Docstring: Returns a value when no prior conditions are True.
This is the final part of a when-chain, like the 'else' in an if-elif-else.
All branches must return the same type.
Args:
value: Value to return when no prior conditi... |
method | is_in | fenic.api.column.Column.is_in | Check if the column is in a list of values or a column expression.
Args:
other (Union[List[Any], ColumnOrName]): A list of values or a Column expression
Returns:
Column: A Column expression representing whether each element of Column is in the list
Example: Check if name is in a list of values
```python
... | null | true | false | 696 | 724 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: is_in
Qualified Name: fenic.api.column.Column.is_in
Docstring: Check if the column is in a list of values or a column expression.
Args:
other (Union[List[Any], ColumnOrName]): A list of values or a Column expression
Returns:
Column: A Column expression representing whether each eleme... |
method | _from_logical_expr | fenic.api.column.Column._from_logical_expr | Create a Column from a LogicalExpr.
Enforces that SortExpr and AggregateExpr do not appear nested inside
the expression by checking immediate children, ensuring these expressions
only appear at the root of the tree. | null | false | true | 726 | 756 | null | Column | null | [
"cls",
"logical_expr"
] | null | Column | Type: method
Member Name: _from_logical_expr
Qualified Name: fenic.api.column.Column._from_logical_expr
Docstring: Create a Column from a LogicalExpr.
Enforces that SortExpr and AggregateExpr do not appear nested inside
the expression by checking immediate children, ensuring these expressions
only appear at the root o... |
method | _from_column_name | fenic.api.column.Column._from_column_name | null | null | false | true | 758 | 764 | null | null | null | [
"cls",
"col_name"
] | null | Column | Type: method
Member Name: _from_column_name
Qualified Name: fenic.api.column.Column._from_column_name
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["cls", "col_name"]
Returns: none
Parent Class: Column |
method | _from_col_or_name | fenic.api.column.Column._from_col_or_name | null | null | false | true | 766 | 771 | null | Column | null | [
"cls",
"col_or_name"
] | null | Column | Type: method
Member Name: _from_col_or_name
Qualified Name: fenic.api.column.Column._from_col_or_name
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["cls", "col_or_name"]
Returns: Column
Parent Class: Column |
method | _create_binary_expr | fenic.api.column.Column._create_binary_expr | null | null | false | true | 773 | 787 | null | Column | null | [
"self",
"other",
"op",
"expr_class",
"reverse"
] | null | Column | Type: method
Member Name: _create_binary_expr
Qualified Name: fenic.api.column.Column._create_binary_expr
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "other", "op", "expr_class", "reverse"]
Returns: Column
Parent Class: Column |
method | __invert__ | fenic.api.column.Column.__invert__ | Logical NOT operation. | null | true | false | 789 | 791 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: __invert__
Qualified Name: fenic.api.column.Column.__invert__
Docstring: Logical NOT operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: Column
Parent Class: Column |
method | __gt__ | fenic.api.column.Column.__gt__ | Greater than comparison. | null | true | false | 793 | 795 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: __gt__
Qualified Name: fenic.api.column.Column.__gt__
Docstring: Greater than comparison.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __ge__ | fenic.api.column.Column.__ge__ | Greater than or equal comparison. | null | true | false | 797 | 799 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: __ge__
Qualified Name: fenic.api.column.Column.__ge__
Docstring: Greater than or equal comparison.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __lt__ | fenic.api.column.Column.__lt__ | Less than comparison. | null | true | false | 801 | 803 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: __lt__
Qualified Name: fenic.api.column.Column.__lt__
Docstring: Less than comparison.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __le__ | fenic.api.column.Column.__le__ | Less than or equal comparison. | null | true | false | 805 | 807 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: __le__
Qualified Name: fenic.api.column.Column.__le__
Docstring: Less than or equal comparison.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __eq__ | fenic.api.column.Column.__eq__ | Equality comparison. | null | true | false | 809 | 811 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: __eq__
Qualified Name: fenic.api.column.Column.__eq__
Docstring: Equality comparison.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __ne__ | fenic.api.column.Column.__ne__ | Not equal comparison. | null | true | false | 813 | 815 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: __ne__
Qualified Name: fenic.api.column.Column.__ne__
Docstring: Not equal comparison.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __and__ | fenic.api.column.Column.__and__ | Logical AND operation. | null | true | false | 817 | 819 | null | Column | null | [
"self",
"other"
] | null | Column | Type: method
Member Name: __and__
Qualified Name: fenic.api.column.Column.__and__
Docstring: Logical AND operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: Column
Parent Class: Column |
method | __rand__ | fenic.api.column.Column.__rand__ | Reverse logical AND operation. | null | true | false | 821 | 823 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 825 | 827 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 829 | 831 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 833 | 835 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 837 | 841 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 843 | 845 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 847 | 851 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 853 | 855 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 857 | 859 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 861 | 863 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 865 | 869 | null | Column | null | [
"self",
"other"
] | null | Column | 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. | null | true | false | 871 | 875 | null | null | null | [
"self"
] | null | Column | 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 | null | true | false | 877 | 877 | null | null | Union[Column, str] | null | null | 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. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/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 | null | false | false | 9 | 9 | null | null | ['DataFrame', 'GroupedData', 'SemanticExtensions'] | null | null | 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 | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/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. | null | true | false | 24 | 96 | 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 | null | true | false | 27 | 28 | null | null | null | [
"self",
"df"
] | null | BaseGroupedData | 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. | null | false | true | 30 | 53 | null | List[Column] | null | [
"self",
"agg_dict"
] | null | BaseGroupedData | 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. | null | false | true | 55 | 72 | null | List[AliasExpr] | null | [
"self",
"cols"
] | null | BaseGroupedData | 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. | null | false | true | 74 | 96 | null | None | null | [
"self",
"exprs"
] | null | BaseGroupedData | 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. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/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 | null | true | false | 60 | 60 | null | null | logging.getLogger(__name__) | null | null | 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... | null | true | false | 63 | 2,008 | 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(). | null | true | false | 95 | 104 | null | null | null | [
"cls"
] | null | DataFrame | 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... | null | false | true | 106 | 129 | null | DataFrame | null | [
"cls",
"logical_plan",
"session_state"
] | null | DataFrame | 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... | null | true | false | 174 | 202 | null | Column | null | [
"self",
"col_name"
] | null | DataFrame | 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... | null | true | false | 204 | 231 | null | Column | null | [
"self",
"col_name"
] | null | DataFrame | 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. | null | true | false | 233 | 235 | null | None | null | [
"self"
] | null | DataFrame | 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 | null | true | false | 237 | 251 | null | None | null | [
"self",
"n",
"explain_analyze"
] | null | DataFrame | 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:
... | null | true | false | 253 | 281 | null | QueryResult | null | [
"self",
"data_type"
] | null | DataFrame | 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... | null | true | false | 283 | 293 | null | pl.DataFrame | null | [
"self"
] | null | DataFrame | 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... | null | true | false | 295 | 305 | null | pd.DataFrame | null | [
"self"
] | null | DataFrame | 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... | null | true | false | 307 | 318 | null | pa.Table | null | [
"self"
] | null | DataFrame | 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[... | null | true | false | 320 | 332 | null | Dict[str, List[Any]] | null | [
"self"
] | null | DataFrame | 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... | null | true | false | 334 | 349 | null | List[Dict[str, Any]] | null | [
"self"
] | null | DataFrame | 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 | null | true | false | 351 | 360 | null | int | null | [
"self"
] | null | DataFrame | 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
... | null | true | false | 362 | 387 | null | Lineage | null | [
"self"
] | null | DataFrame | 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 created once and reused multiple times in your workflow
- DataFrames that are computational... | null | true | false | 389 | 417 | null | DataFrame | null | [
"self"
] | null | DataFrame | 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:
- DataFr... |
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 | null | true | false | 419 | 428 | null | DataFrame | null | [
"self"
] | null | DataFrame | 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
... | null | true | false | 430 | 498 | null | DataFrame | null | [
"self",
"cols"
] | null | DataFrame | 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 | null | true | false | 500 | 512 | null | DataFrame | null | [
"self",
"condition"
] | null | DataFrame | 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... | null | true | false | 514 | 568 | null | DataFrame | null | [
"self",
"condition"
] | null | DataFrame | 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, Series, or value to assign to the column:
- Column: A Column expression (e.g., `col("age") + 1`)
- `pl.Series` or `pd.Series`: A Polars or pandas Series with data
- **Note... | null | true | false | 570 | 712 | null | DataFrame | null | [
"self",
"col_name",
"col"
] | null | DataFrame | 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, Series, or value to assign to the column:
- Column: A Column expression (e... |
method | with_columns | fenic.api.dataframe.dataframe.DataFrame.with_columns | Add multiple new columns or replace existing columns.
Args:
cols_map: A dictionary where keys are column names and values are:
- Column: Column expressions (e.g., col("age") + 1)
- pl.Series or pd.Series: Series with data
- **Note: Series length MUST match the DataFrame height**
... | null | true | false | 714 | 886 | null | DataFrame | null | [
"self",
"cols_map"
] | null | DataFrame | Type: method
Member Name: with_columns
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.with_columns
Docstring: Add multiple new columns or replace existing columns.
Args:
cols_map: A dictionary where keys are column names and values are:
- Column: Column expressions (e.g., col("age") + 1)
... |
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({
... | null | true | false | 888 | 952 | null | DataFrame | null | [
"self",
"col_name",
"new_col_name"
] | null | DataFrame | 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.
... | null | true | false | 954 | 1,034 | null | DataFrame | null | [
"self",
"col_names"
] | null | DataFrame | 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.
... | null | true | false | 1,036 | 1,116 | null | DataFrame | null | [
"self",
"other"
] | null | DataFrame | 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... | null | true | false | 1,118 | 1,165 | null | DataFrame | null | [
"self",
"n"
] | null | DataFrame | 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... | null | true | false | 1,186 | 1,303 | null | DataFrame | null | [
"self",
"other",
"on",
"left_on",
"right_on",
"how"
] | null | DataFrame | 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 ... | null | true | false | 1,305 | 1,362 | null | DataFrame | null | [
"self",
"column"
] | null | DataFrame | 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 | explode_with_index | fenic.api.dataframe.dataframe.DataFrame.explode_with_index | Create a new row for each element in an array column, with the element's position in the array and its value.
This operation is similar to explode(), but also adds a column containing the 0-based
position of each element within its original array. By default, the position column is named "pos".
and the value column is... | null | true | false | 1,364 | 1,432 | null | DataFrame | null | [
"self",
"column",
"index_col_name",
"value_col_name",
"keep_null_and_empty"
] | null | DataFrame | Type: method
Member Name: explode_with_index
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.explode_with_index
Docstring: Create a new row for each element in an array column, with the element's position in the array and its value.
This operation is similar to explode(), but also adds a column containing the ... |
method | posexplode | fenic.api.dataframe.dataframe.DataFrame.posexplode | Create a new row for each element in an array column, with the element's position in the array and its value.
This is a PySpark-compatible alias for explode_with_index.
Creates two columns: 'pos' (0-based position) and 'col' (the array element value).
These columns replace the original column in the output DataFrame.
... | null | true | false | 1,434 | 1,465 | null | DataFrame | null | [
"self",
"column"
] | null | DataFrame | Type: method
Member Name: posexplode
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.posexplode
Docstring: Create a new row for each element in an array column, with the element's position in the array and its value.
This is a PySpark-compatible alias for explode_with_index.
Creates two columns: 'pos' (0-based... |
method | explode_outer | fenic.api.dataframe.dataframe.DataFrame.explode_outer | Create a new row for each element in an array column, containing the element's position in the array and its value, and preserving null/empty arrays.
This operation is similar to explode(), but keeps rows where the array column
is null or empty, producing a row with null in the exploded column.
Args:
column: Name... | null | true | false | 1,467 | 1,507 | null | DataFrame | null | [
"self",
"column"
] | null | DataFrame | Type: method
Member Name: explode_outer
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.explode_outer
Docstring: Create a new row for each element in an array column, containing the element's position in the array and its value, and preserving null/empty arrays.
This operation is similar to explode(), but keep... |
method | posexplode_outer | fenic.api.dataframe.dataframe.DataFrame.posexplode_outer | Create a new row for each element in an array column with position and value, preserving null/empty arrays.
This is a PySpark-compatible alias for explode_with_index with keep_null_and_empty=True.
Creates two columns: 'pos' (0-based position) and 'col' (the array element value).
Rows with null or empty arrays produce ... | null | true | false | 1,509 | 1,544 | null | DataFrame | null | [
"self",
"column"
] | null | DataFrame | Type: method
Member Name: posexplode_outer
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.posexplode_outer
Docstring: Create a new row for each element in an array column with position and value, preserving null/empty arrays.
This is a PySpark-compatible alias for explode_with_index with keep_null_and_empty=T... |
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.... | null | true | false | 1,546 | 1,600 | null | GroupedData | null | [
"self",
"cols"
] | null | DataFrame | 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... | null | true | false | 1,602 | 1,646 | null | DataFrame | null | [
"self",
"exprs"
] | null | DataFrame | 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 | distinct | fenic.api.dataframe.dataframe.DataFrame.distinct | Return a DataFrame with duplicate rows removed. Alias for drop_duplicates(subset=None).
Returns:
DataFrame: A new DataFrame with duplicate rows removed.
Example:
```python
# Create sample DataFrame
df = session.create_dataframe({
"c1": [1, 2, 3, 1],
"c2": ["a", "a", "a", "a"],
... | null | true | false | 1,648 | 1,675 | null | DataFrame | null | [
"self"
] | null | DataFrame | Type: method
Member Name: distinct
Qualified Name: fenic.api.dataframe.dataframe.DataFrame.distinct
Docstring: Return a DataFrame with duplicate rows removed. Alias for drop_duplicates(subset=None).
Returns:
DataFrame: A new DataFrame with duplicate rows removed.
Example:
```python
# Create sample DataFra... |
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... | null | true | false | 1,677 | 1,734 | null | DataFrame | null | [
"self",
"subset"
] | null | DataFrame | 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")`,... | null | true | false | 1,736 | 1,898 | null | DataFrame | null | [
"self",
"cols",
"ascending"
] | null | DataFrame | 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. | null | true | false | 1,900 | 1,913 | null | DataFrame | null | [
"self",
"cols",
"ascending"
] | null | DataFrame | 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... | null | true | false | 1,915 | 1,989 | null | DataFrame | null | [
"self",
"col_names"
] | null | DataFrame | 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. | null | false | true | 1,991 | 2,008 | null | null | null | [
"cls",
"session_state",
"other_session_states"
] | null | DataFrame | 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. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/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. | null | true | false | 19 | 94 | null | null | null | null | [
"BaseGroupedData"
] | null | 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. | null | true | false | 22 | 43 | null | null | null | [
"self",
"df",
"by"
] | null | GroupedData | 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 ... | null | true | false | 45 | 94 | null | DataFrame | null | [
"self",
"exprs"
] | null | GroupedData | 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. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.