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 | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.TableSource.__init__ | null | null | true | false | 105 | 105 | null | None | null | [
"self",
"table_name"
] | null | TableSource | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.TableSource.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name"]
Returns: None
Parent Class: TableSource |
class | DocSource | fenic._gen.protos.logical_plan.v1.plans_pb2.DocSource | null | null | true | false | 107 | 117 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: DocSource
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.DocSource
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.DocSource.__init__ | null | null | true | false | 117 | 117 | null | None | null | [
"self",
"paths",
"content_type",
"exclude",
"recursive"
] | null | DocSource | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.DocSource.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "paths", "content_type", "exclude", "recursive"]
Returns: None
Parent Class: DocSource |
class | Projection | fenic._gen.protos.logical_plan.v1.plans_pb2.Projection | null | null | true | false | 119 | 125 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Projection
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Projection
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Projection.__init__ | null | null | true | false | 125 | 125 | null | None | null | [
"self",
"input",
"exprs"
] | null | Projection | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Projection.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "exprs"]
Returns: None
Parent Class: Projection |
class | Filter | fenic._gen.protos.logical_plan.v1.plans_pb2.Filter | null | null | true | false | 127 | 133 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Filter
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Filter
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Filter.__init__ | null | null | true | false | 133 | 133 | null | None | null | [
"self",
"input",
"predicate"
] | null | Filter | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Filter.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "predicate"]
Returns: None
Parent Class: Filter |
class | Join | fenic._gen.protos.logical_plan.v1.plans_pb2.Join | null | null | true | false | 135 | 147 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Join
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Join
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Join.__init__ | null | null | true | false | 147 | 147 | null | None | null | [
"self",
"left",
"right",
"join_type",
"left_on",
"right_on"
] | null | Join | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Join.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "left", "right", "join_type", "left_on", "right_on"]
Returns: None
Parent Class: Join |
class | SemanticJoin | fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticJoin | null | null | true | false | 149 | 169 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: SemanticJoin
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticJoin
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticJoin.__init__ | null | null | true | false | 169 | 169 | null | None | null | [
"self",
"left",
"right",
"left_on",
"right_on",
"jinja_template",
"strict",
"temperature",
"model_alias",
"examples"
] | null | SemanticJoin | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticJoin.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "left", "right", "left_on", "right_on", "jinja_template", "strict", "temperature", "model_alias", "... |
class | SemanticSimilarityJoin | fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticSimilarityJoin | null | null | true | false | 171 | 195 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: SemanticSimilarityJoin
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticSimilarityJoin
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticSimilarityJoin.__init__ | null | null | true | false | 195 | 195 | null | None | null | [
"self",
"left",
"right",
"left_on",
"right_on",
"k",
"similarity_metric",
"similarity_score_column"
] | null | SemanticSimilarityJoin | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticSimilarityJoin.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "left", "right", "left_on", "right_on", "k", "similarity_metric", "similarity_score_colum... |
class | Aggregate | fenic._gen.protos.logical_plan.v1.plans_pb2.Aggregate | null | null | true | false | 197 | 205 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Aggregate
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Aggregate
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Aggregate.__init__ | null | null | true | false | 205 | 205 | null | None | null | [
"self",
"input",
"group_exprs",
"agg_exprs"
] | null | Aggregate | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Aggregate.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "group_exprs", "agg_exprs"]
Returns: None
Parent Class: Aggregate |
class | Union | fenic._gen.protos.logical_plan.v1.plans_pb2.Union | null | null | true | false | 207 | 211 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Union
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Union
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Union.__init__ | null | null | true | false | 211 | 211 | null | None | null | [
"self",
"inputs"
] | null | Union | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Union.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "inputs"]
Returns: None
Parent Class: Union |
class | Limit | fenic._gen.protos.logical_plan.v1.plans_pb2.Limit | null | null | true | false | 213 | 219 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Limit
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Limit
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Limit.__init__ | null | null | true | false | 219 | 219 | null | None | null | [
"self",
"input",
"n"
] | null | Limit | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Limit.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "n"]
Returns: None
Parent Class: Limit |
class | Explode | fenic._gen.protos.logical_plan.v1.plans_pb2.Explode | null | null | true | false | 221 | 229 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Explode
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Explode
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Explode.__init__ | null | null | true | false | 229 | 229 | null | None | null | [
"self",
"input",
"expr",
"keep_null_and_empty"
] | null | Explode | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Explode.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "expr", "keep_null_and_empty"]
Returns: None
Parent Class: Explode |
class | ExplodeWithIndex | fenic._gen.protos.logical_plan.v1.plans_pb2.ExplodeWithIndex | null | null | true | false | 231 | 243 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: ExplodeWithIndex
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.ExplodeWithIndex
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.ExplodeWithIndex.__init__ | null | null | true | false | 243 | 243 | null | None | null | [
"self",
"input",
"expr",
"index_name",
"value_name",
"keep_null_and_empty"
] | null | ExplodeWithIndex | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.ExplodeWithIndex.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "expr", "index_name", "value_name", "keep_null_and_empty"]
Returns: None
Parent Class:... |
class | DropDuplicates | fenic._gen.protos.logical_plan.v1.plans_pb2.DropDuplicates | null | null | true | false | 245 | 251 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: DropDuplicates
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.DropDuplicates
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.DropDuplicates.__init__ | null | null | true | false | 251 | 251 | null | None | null | [
"self",
"input",
"subset"
] | null | DropDuplicates | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.DropDuplicates.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "subset"]
Returns: None
Parent Class: DropDuplicates |
class | Sort | fenic._gen.protos.logical_plan.v1.plans_pb2.Sort | null | null | true | false | 253 | 259 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Sort
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Sort
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Sort.__init__ | null | null | true | false | 259 | 259 | null | None | null | [
"self",
"input",
"sort_exprs"
] | null | Sort | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Sort.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "sort_exprs"]
Returns: None
Parent Class: Sort |
class | Unnest | fenic._gen.protos.logical_plan.v1.plans_pb2.Unnest | null | null | true | false | 261 | 267 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: Unnest
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Unnest
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.Unnest.__init__ | null | null | true | false | 267 | 267 | null | None | null | [
"self",
"input",
"exprs"
] | null | Unnest | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.Unnest.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "exprs"]
Returns: None
Parent Class: Unnest |
class | SQL | fenic._gen.protos.logical_plan.v1.plans_pb2.SQL | null | null | true | false | 269 | 277 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: SQL
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SQL
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.SQL.__init__ | null | null | true | false | 277 | 277 | null | None | null | [
"self",
"inputs",
"template_names",
"templated_query"
] | null | SQL | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SQL.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "inputs", "template_names", "templated_query"]
Returns: None
Parent Class: SQL |
class | SemanticCluster | fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticCluster | null | null | true | false | 279 | 295 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: SemanticCluster
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticCluster
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticCluster.__init__ | null | null | true | false | 295 | 295 | null | None | null | [
"self",
"input",
"by_expr",
"num_clusters",
"max_iter",
"num_init",
"label_column",
"centroid_column"
] | null | SemanticCluster | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.SemanticCluster.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "input", "by_expr", "num_clusters", "max_iter", "num_init", "label_column", "centroid_column"]
R... |
class | FileSink | fenic._gen.protos.logical_plan.v1.plans_pb2.FileSink | null | null | true | false | 297 | 307 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: FileSink
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.FileSink
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.FileSink.__init__ | null | null | true | false | 307 | 307 | null | None | null | [
"self",
"child",
"sink_type",
"path",
"mode"
] | null | FileSink | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.FileSink.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "child", "sink_type", "path", "mode"]
Returns: None
Parent Class: FileSink |
class | TableSink | fenic._gen.protos.logical_plan.v1.plans_pb2.TableSink | null | null | true | false | 309 | 317 | null | null | null | null | [
"_message.Message"
] | null | Type: class
Member Name: TableSink
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.TableSink
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic._gen.protos.logical_plan.v1.plans_pb2.TableSink.__init__ | null | null | true | false | 317 | 317 | null | None | null | [
"self",
"child",
"table_name",
"mode"
] | null | TableSink | Type: method
Member Name: __init__
Qualified Name: fenic._gen.protos.logical_plan.v1.plans_pb2.TableSink.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "child", "table_name", "mode"]
Returns: None
Parent Class: TableSink |
module | api | fenic.api | Query module for semantic operations on DataFrames. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/api/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: api
Qualified Name: fenic.api
Docstring: Query module for semantic operations on DataFrames.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.api.__all__ | null | null | false | false | 77 | 158 | null | null | ['Session', 'SessionConfig', 'OpenAILanguageModel', 'OpenAIEmbeddingModel', 'AnthropicLanguageModel', 'CohereEmbeddingModel', 'GoogleDeveloperEmbeddingModel', 'GoogleDeveloperLanguageModel', 'GoogleVertexEmbeddingModel', 'GoogleVertexLanguageModel', 'OpenRouterLanguageModel', 'SemanticConfig', 'CloudConfig', 'AdaptiveT... | null | null | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.api.__all__
Docstring: none
Value: ['Session', 'SessionConfig', 'OpenAILanguageModel', 'OpenAIEmbeddingModel', 'AnthropicLanguageModel', 'CohereEmbeddingModel', 'GoogleDeveloperEmbeddingModel', 'GoogleDeveloperLanguageModel', 'GoogleVertexEmbeddingModel', 'Goog... |
module | catalog | fenic.api.catalog | Catalog API for managing database objects in Fenic. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/api/catalog.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: catalog
Qualified Name: fenic.api.catalog
Docstring: Catalog API for managing database objects in Fenic.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | Catalog | fenic.api.catalog.Catalog | Entry point for catalog operations.
Provides methods to manage catalogs, databases, and tables, as well as
read-only access to system tables such as `fenic_system.query_metrics`.
### Catalog and Database Management
Example:
```python
# Create a catalog
session.catalog.create_catalog("my_catalog") # → Tru... | null | true | false | 13 | 773 | null | null | null | null | [] | null | Type: class
Member Name: Catalog
Qualified Name: fenic.api.catalog.Catalog
Docstring: Entry point for catalog operations.
Provides methods to manage catalogs, databases, and tables, as well as
read-only access to system tables such as `fenic_system.query_metrics`.
### Catalog and Database Management
Example:
```p... |
method | __init__ | fenic.api.catalog.Catalog.__init__ | Initialize a Catalog instance.
Args:
catalog: The underlying catalog implementation. | null | true | false | 86 | 92 | null | null | null | [
"self",
"catalog"
] | null | Catalog | Type: method
Member Name: __init__
Qualified Name: fenic.api.catalog.Catalog.__init__
Docstring: Initialize a Catalog instance.
Args:
catalog: The underlying catalog implementation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "catalog"]
Returns: none
Parent Class: Catalo... |
method | does_catalog_exist | fenic.api.catalog.Catalog.does_catalog_exist | Checks if a catalog with the specified name exists.
Args:
catalog_name (str): Name of the catalog to check.
Returns:
bool: True if the catalog exists, False otherwise.
Example: Check if a catalog exists
```python
# Check if 'my_catalog' exists
session.catalog.does_catalog_exist('my_catalog')
... | null | true | false | 95 | 112 | null | bool | null | [
"self",
"catalog_name"
] | null | Catalog | Type: method
Member Name: does_catalog_exist
Qualified Name: fenic.api.catalog.Catalog.does_catalog_exist
Docstring: Checks if a catalog with the specified name exists.
Args:
catalog_name (str): Name of the catalog to check.
Returns:
bool: True if the catalog exists, False otherwise.
Example: Check if a cata... |
method | get_current_catalog | fenic.api.catalog.Catalog.get_current_catalog | Returns the name of the current catalog.
Returns:
str: The name of the current catalog.
Example: Get current catalog name
```python
# Get the name of the current catalog
session.catalog.get_current_catalog()
# Returns: 'default'
``` | null | true | false | 114 | 127 | null | str | null | [
"self"
] | null | Catalog | Type: method
Member Name: get_current_catalog
Qualified Name: fenic.api.catalog.Catalog.get_current_catalog
Docstring: Returns the name of the current catalog.
Returns:
str: The name of the current catalog.
Example: Get current catalog name
```python
# Get the name of the current catalog
session.catal... |
method | set_current_catalog | fenic.api.catalog.Catalog.set_current_catalog | Sets the current catalog.
Args:
catalog_name (str): Name of the catalog to set as current.
Raises:
ValueError: If the specified catalog doesn't exist.
Example: Set current catalog
```python
# Set 'my_catalog' as the current catalog
session.catalog.set_current_catalog('my_catalog')
``` | null | true | false | 129 | 145 | null | None | null | [
"self",
"catalog_name"
] | null | Catalog | Type: method
Member Name: set_current_catalog
Qualified Name: fenic.api.catalog.Catalog.set_current_catalog
Docstring: Sets the current catalog.
Args:
catalog_name (str): Name of the catalog to set as current.
Raises:
ValueError: If the specified catalog doesn't exist.
Example: Set current catalog
```pyt... |
method | list_catalogs | fenic.api.catalog.Catalog.list_catalogs | Returns a list of available catalogs.
Returns:
List[str]: A list of catalog names available in the system.
Returns an empty list if no catalogs are found.
Example: List all catalogs
```python
# Get all available catalogs
session.catalog.list_catalogs()
# Returns: ['default', 'my_catalog', 'oth... | null | true | false | 147 | 161 | null | List[str] | null | [
"self"
] | null | Catalog | Type: method
Member Name: list_catalogs
Qualified Name: fenic.api.catalog.Catalog.list_catalogs
Docstring: Returns a list of available catalogs.
Returns:
List[str]: A list of catalog names available in the system.
Returns an empty list if no catalogs are found.
Example: List all catalogs
```python
# G... |
method | create_catalog | fenic.api.catalog.Catalog.create_catalog | Creates a new catalog.
Args:
catalog_name (str): Name of the catalog to create.
ignore_if_exists (bool): If True, return False when the catalog already exists.
If False, raise an error when the catalog already exists.
Defaults to True.
Raises:
CatalogAlreadyExistsError: If the catalog alre... | null | true | false | 163 | 201 | null | bool | null | [
"self",
"catalog_name",
"ignore_if_exists"
] | null | Catalog | Type: method
Member Name: create_catalog
Qualified Name: fenic.api.catalog.Catalog.create_catalog
Docstring: Creates a new catalog.
Args:
catalog_name (str): Name of the catalog to create.
ignore_if_exists (bool): If True, return False when the catalog already exists.
If False, raise an error when the ... |
method | drop_catalog | fenic.api.catalog.Catalog.drop_catalog | Drops a catalog.
Args:
catalog_name (str): Name of the catalog to drop.
ignore_if_not_exists (bool): If True, silently return if the catalog doesn't exist.
If False, raise an error if the catalog doesn't exist.
Defaults to True.
Raises:
CatalogNotFoundError: If the catalog does not exist a... | null | true | false | 203 | 236 | null | bool | null | [
"self",
"catalog_name",
"ignore_if_not_exists"
] | null | Catalog | Type: method
Member Name: drop_catalog
Qualified Name: fenic.api.catalog.Catalog.drop_catalog
Docstring: Drops a catalog.
Args:
catalog_name (str): Name of the catalog to drop.
ignore_if_not_exists (bool): If True, silently return if the catalog doesn't exist.
If False, raise an error if the catalog do... |
method | does_database_exist | fenic.api.catalog.Catalog.does_database_exist | Checks if a database with the specified name exists.
Args:
database_name (str): Fully qualified or relative database name to check.
Returns:
bool: True if the database exists, False otherwise.
Example: Check if a database exists
```python
# Check if 'my_database' exists
session.catalog.does_datab... | null | true | false | 238 | 255 | null | bool | null | [
"self",
"database_name"
] | null | Catalog | Type: method
Member Name: does_database_exist
Qualified Name: fenic.api.catalog.Catalog.does_database_exist
Docstring: Checks if a database with the specified name exists.
Args:
database_name (str): Fully qualified or relative database name to check.
Returns:
bool: True if the database exists, False otherwise... |
method | get_current_database | fenic.api.catalog.Catalog.get_current_database | Returns the name of the current database in the current catalog.
Returns:
str: The name of the current database.
Example: Get current database name
```python
# Get the name of the current database
session.catalog.get_current_database()
# Returns: 'default'
``` | null | true | false | 257 | 270 | null | str | null | [
"self"
] | null | Catalog | Type: method
Member Name: get_current_database
Qualified Name: fenic.api.catalog.Catalog.get_current_database
Docstring: Returns the name of the current database in the current catalog.
Returns:
str: The name of the current database.
Example: Get current database name
```python
# Get the name of the curre... |
method | set_current_database | fenic.api.catalog.Catalog.set_current_database | Sets the current database.
Args:
database_name (str): Fully qualified or relative database name to set as current.
Raises:
DatabaseNotFoundError: If the specified database doesn't exist.
Example: Set current database
```python
# Set 'my_database' as the current database
session.catalog.set_curren... | null | true | false | 272 | 288 | null | None | null | [
"self",
"database_name"
] | null | Catalog | Type: method
Member Name: set_current_database
Qualified Name: fenic.api.catalog.Catalog.set_current_database
Docstring: Sets the current database.
Args:
database_name (str): Fully qualified or relative database name to set as current.
Raises:
DatabaseNotFoundError: If the specified database doesn't exist.
E... |
method | list_databases | fenic.api.catalog.Catalog.list_databases | Returns a list of databases in the current catalog.
Returns:
List[str]: A list of database names in the current catalog.
Returns an empty list if no databases are found.
Example: List all databases
```python
# Get all databases in the current catalog
session.catalog.list_databases()
# Returns:... | null | true | false | 290 | 304 | null | List[str] | null | [
"self"
] | null | Catalog | Type: method
Member Name: list_databases
Qualified Name: fenic.api.catalog.Catalog.list_databases
Docstring: Returns a list of databases in the current catalog.
Returns:
List[str]: A list of database names in the current catalog.
Returns an empty list if no databases are found.
Example: List all databases
... |
method | create_database | fenic.api.catalog.Catalog.create_database | Creates a new database.
Args:
database_name (str): Fully qualified or relative database name to create.
ignore_if_exists (bool): If True, return False when the database already exists.
If False, raise an error when the database already exists.
Defaults to True.
Raises:
DatabaseAlreadyExist... | null | true | false | 306 | 346 | null | bool | null | [
"self",
"database_name",
"ignore_if_exists"
] | null | Catalog | Type: method
Member Name: create_database
Qualified Name: fenic.api.catalog.Catalog.create_database
Docstring: Creates a new database.
Args:
database_name (str): Fully qualified or relative database name to create.
ignore_if_exists (bool): If True, return False when the database already exists.
If Fals... |
method | drop_database | fenic.api.catalog.Catalog.drop_database | Drops a database.
Args:
database_name (str): Fully qualified or relative database name to drop.
cascade (bool): If True, drop all tables in the database.
Defaults to False.
ignore_if_not_exists (bool): If True, silently return if the database doesn't exist.
If False, raise an error if the d... | null | true | false | 348 | 387 | null | bool | null | [
"self",
"database_name",
"cascade",
"ignore_if_not_exists"
] | null | Catalog | Type: method
Member Name: drop_database
Qualified Name: fenic.api.catalog.Catalog.drop_database
Docstring: Drops a database.
Args:
database_name (str): Fully qualified or relative database name to drop.
cascade (bool): If True, drop all tables in the database.
Defaults to False.
ignore_if_not_exist... |
method | does_table_exist | fenic.api.catalog.Catalog.does_table_exist | Checks if a table with the specified name exists.
Args:
table_name (str): Fully qualified or relative table name to check.
Returns:
bool: True if the table exists, False otherwise.
Example: Check if a table exists
```python
# Check if 'my_table' exists
session.catalog.does_table_exist('my_table')... | null | true | false | 389 | 406 | null | bool | null | [
"self",
"table_name"
] | null | Catalog | Type: method
Member Name: does_table_exist
Qualified Name: fenic.api.catalog.Catalog.does_table_exist
Docstring: Checks if a table with the specified name exists.
Args:
table_name (str): Fully qualified or relative table name to check.
Returns:
bool: True if the table exists, False otherwise.
Example: Check ... |
method | list_tables | fenic.api.catalog.Catalog.list_tables | Returns a list of tables stored in the current database.
This method queries the current database to retrieve all available table names.
Returns:
List[str]: A list of table names stored in the database.
Returns an empty list if no tables are found.
Example: List all tables
```python
# Get all tables ... | null | true | false | 408 | 424 | null | List[str] | null | [
"self"
] | null | Catalog | Type: method
Member Name: list_tables
Qualified Name: fenic.api.catalog.Catalog.list_tables
Docstring: Returns a list of tables stored in the current database.
This method queries the current database to retrieve all available table names.
Returns:
List[str]: A list of table names stored in the database.
Retu... |
method | describe_table | fenic.api.catalog.Catalog.describe_table | Returns the schema of the specified table.
Args:
table_name (str): Fully qualified or relative table name to describe.
Returns:
DatasetMetadata: An object containing:
schema: A schema object describing the table's structure with field names and types.
description: A natural language descriptio... | null | true | false | 426 | 450 | null | DatasetMetadata | null | [
"self",
"table_name"
] | null | Catalog | Type: method
Member Name: describe_table
Qualified Name: fenic.api.catalog.Catalog.describe_table
Docstring: Returns the schema of the specified table.
Args:
table_name (str): Fully qualified or relative table name to describe.
Returns:
DatasetMetadata: An object containing:
schema: A schema object de... |
method | set_table_description | fenic.api.catalog.Catalog.set_table_description | Set or unset the description for a table.
Args:
table_name: Fully qualified or relative table name to set the description for.
description: The description to set for the table.
Raises:
TableNotFoundError: If the table doesn't exist. | null | true | false | 452 | 463 | null | None | null | [
"self",
"table_name",
"description"
] | null | Catalog | Type: method
Member Name: set_table_description
Qualified Name: fenic.api.catalog.Catalog.set_table_description
Docstring: Set or unset the description for a table.
Args:
table_name: Fully qualified or relative table name to set the description for.
description: The description to set for the table.
Raises:
... |
method | drop_table | fenic.api.catalog.Catalog.drop_table | Drops the specified table.
By default this method will return False if the table doesn't exist.
Args:
table_name (str): Fully qualified or relative table name to drop.
ignore_if_not_exists (bool): If True, return False when the table doesn't exist.
If False, raise an error when the table doesn't exist... | null | true | false | 465 | 505 | null | bool | null | [
"self",
"table_name",
"ignore_if_not_exists"
] | null | Catalog | Type: method
Member Name: drop_table
Qualified Name: fenic.api.catalog.Catalog.drop_table
Docstring: Drops the specified table.
By default this method will return False if the table doesn't exist.
Args:
table_name (str): Fully qualified or relative table name to drop.
ignore_if_not_exists (bool): If True, ret... |
method | create_table | fenic.api.catalog.Catalog.create_table | Creates a new table.
Args:
table_name (str): Fully qualified or relative table name to create.
schema (Schema): Schema of the table to create.
ignore_if_exists (bool): If True, return False when the table already exists.
If False, raise an error when the table already exists.
Defaults to Tr... | null | true | false | 507 | 556 | null | bool | null | [
"self",
"table_name",
"schema",
"ignore_if_exists",
"description"
] | null | Catalog | Type: method
Member Name: create_table
Qualified Name: fenic.api.catalog.Catalog.create_table
Docstring: Creates a new table.
Args:
table_name (str): Fully qualified or relative table name to create.
schema (Schema): Schema of the table to create.
ignore_if_exists (bool): If True, return False when the tab... |
method | list_views | fenic.api.catalog.Catalog.list_views | Returns a list of views stored in the current database.
This method queries the current database to retrieve all available view names.
Returns:
List[str]: A list of view names stored in the database.
Returns an empty list if no views are found.
Example:
>>> session.catalog.list_views()
['view1', 'vie... | null | true | false | 558 | 571 | null | List[str] | null | [
"self"
] | null | Catalog | Type: method
Member Name: list_views
Qualified Name: fenic.api.catalog.Catalog.list_views
Docstring: Returns a list of views stored in the current database.
This method queries the current database to retrieve all available view names.
Returns:
List[str]: A list of view names stored in the database.
Returns a... |
method | describe_view | fenic.api.catalog.Catalog.describe_view | Returns the schema and description of the specified view.
Args:
view_name (str): Fully qualified or relative view name to describe.
Returns:
DatasetMetadata: An object containing:
schema: A schema object describing the view's structure with field names and types.
description: A natural languag... | null | true | false | 573 | 589 | null | DatasetMetadata | null | [
"self",
"view_name"
] | null | Catalog | Type: method
Member Name: describe_view
Qualified Name: fenic.api.catalog.Catalog.describe_view
Docstring: Returns the schema and description of the specified view.
Args:
view_name (str): Fully qualified or relative view name to describe.
Returns:
DatasetMetadata: An object containing:
schema: A schem... |
method | set_view_description | fenic.api.catalog.Catalog.set_view_description | Set the description for a view.
Args:
view_name (str): Fully qualified or relative view name to set the description for.
description (str): The description to set for the view.
Raises:
TableNotFoundError: If the view doesn't exist.
ValidationError: If the description is empty.
Example: Set a descript... | null | true | false | 591 | 608 | null | None | null | [
"self",
"view_name",
"description"
] | null | Catalog | Type: method
Member Name: set_view_description
Qualified Name: fenic.api.catalog.Catalog.set_view_description
Docstring: Set the description for a view.
Args:
view_name (str): Fully qualified or relative view name to set the description for.
description (str): The description to set for the view.
Raises:
... |
method | does_view_exist | fenic.api.catalog.Catalog.does_view_exist | Checks if a view with the specified name exists.
Args:
view_name (str): Fully qualified or relative view name to check.
Returns:
bool: True if the view exists, False otherwise.
Example:
>>> session.catalog.does_view_exist('my_view')
True. | null | true | false | 610 | 624 | null | bool | null | [
"self",
"view_name"
] | null | Catalog | Type: method
Member Name: does_view_exist
Qualified Name: fenic.api.catalog.Catalog.does_view_exist
Docstring: Checks if a view with the specified name exists.
Args:
view_name (str): Fully qualified or relative view name to check.
Returns:
bool: True if the view exists, False otherwise.
Example:
>>> sess... |
method | drop_view | fenic.api.catalog.Catalog.drop_view | Drops the specified view.
By default this method will return False if the view doesn't exist.
Args:
view_name (str): Fully qualified or relative view name to drop.
ignore_if_not_exists (bool, optional): If True, return False when the view
doesn't exist. If False, raise an error when the view doesn't e... | null | true | false | 626 | 654 | null | bool | null | [
"self",
"view_name",
"ignore_if_not_exists"
] | null | Catalog | Type: method
Member Name: drop_view
Qualified Name: fenic.api.catalog.Catalog.drop_view
Docstring: Drops the specified view.
By default this method will return False if the view doesn't exist.
Args:
view_name (str): Fully qualified or relative view name to drop.
ignore_if_not_exists (bool, optional): If True,... |
method | describe_tool | fenic.api.catalog.Catalog.describe_tool | Returns the tool with the specified name from the current catalog.
Args:
tool_name (str): The name of the tool to get.
Raises:
ToolNotFoundError: If the tool doesn't exist.
Returns:
Tool: The tool with the specified name. | null | true | false | 656 | 669 | null | UserDefinedTool | null | [
"self",
"tool_name"
] | null | Catalog | Type: method
Member Name: describe_tool
Qualified Name: fenic.api.catalog.Catalog.describe_tool
Docstring: Returns the tool with the specified name from the current catalog.
Args:
tool_name (str): The name of the tool to get.
Raises:
ToolNotFoundError: If the tool doesn't exist.
Returns:
Tool: The tool w... |
method | create_tool | fenic.api.catalog.Catalog.create_tool | Creates a new tool in the current catalog.
Args:
tool_name (str): The name of the tool.
tool_description (str): The description of the tool.
tool_query (DataFrame): The query to execute when the tool is called.
tool_params (Sequence[ToolParam]): The parameters of the tool.
result_limit (int): The m... | null | true | false | 671 | 721 | null | bool | null | [
"self",
"tool_name",
"tool_description",
"tool_query",
"tool_params",
"result_limit",
"ignore_if_exists"
] | null | Catalog | Type: method
Member Name: create_tool
Qualified Name: fenic.api.catalog.Catalog.create_tool
Docstring: Creates a new tool in the current catalog.
Args:
tool_name (str): The name of the tool.
tool_description (str): The description of the tool.
tool_query (DataFrame): The query to execute when the tool is c... |
method | drop_tool | fenic.api.catalog.Catalog.drop_tool | Drops the specified tool from the current catalog.
Args:
tool_name (str): The name of the tool to drop.
ignore_if_not_exists (bool): If True, return False when the tool doesn't exist.
If False, raise an error when the tool doesn't exist.
Defaults to True.
Returns:
bool: True if the tool wa... | null | true | false | 723 | 748 | null | bool | null | [
"self",
"tool_name",
"ignore_if_not_exists"
] | null | Catalog | Type: method
Member Name: drop_tool
Qualified Name: fenic.api.catalog.Catalog.drop_tool
Docstring: Drops the specified tool from the current catalog.
Args:
tool_name (str): The name of the tool to drop.
ignore_if_not_exists (bool): If True, return False when the tool doesn't exist.
If False, raise an e... |
method | list_tools | fenic.api.catalog.Catalog.list_tools | Lists the tools available in the current catalog. | null | true | false | 750 | 752 | null | List[UserDefinedTool] | null | [
"self"
] | null | Catalog | Type: method
Member Name: list_tools
Qualified Name: fenic.api.catalog.Catalog.list_tools
Docstring: Lists the tools available in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[UserDefinedTool]
Parent Class: Catalog |
module | window | fenic.api.window | Window functions for DataFrame operations. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/api/window.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: window
Qualified Name: fenic.api.window
Docstring: Window functions for DataFrame operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | WindowFrameBoundary | fenic.api.window.WindowFrameBoundary | Enumeration of special boundary types for window frames.
These define the limits of a window frame relative to the current row. | null | true | false | 13 | 20 | null | null | null | null | [
"Enum"
] | null | Type: class
Member Name: WindowFrameBoundary
Qualified Name: fenic.api.window.WindowFrameBoundary
Docstring: Enumeration of special boundary types for window frames.
These define the limits of a window frame relative to the current row.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: non... |
attribute | FrameBound | fenic.api.window.FrameBound | Type alias for window frame boundaries.
Can be either:
- An integer offset (positive for following rows, negative for preceding rows)
- A WindowFrameBoundary enum value for special boundaries | null | true | false | 23 | 23 | null | null | Union[int, WindowFrameBoundary] | null | null | null | Type: attribute
Member Name: FrameBound
Qualified Name: fenic.api.window.FrameBound
Docstring: Type alias for window frame boundaries.
Can be either:
- An integer offset (positive for following rows, negative for preceding rows)
- A WindowFrameBoundary enum value for special boundaries
Value: Union[int, WindowFrameBou... |
class | Window | fenic.api.window.Window | Represents the specification for a window in window functions.
Including partitioning, ordering, and frame boundaries. | null | true | false | 32 | 119 | null | null | null | null | [] | null | Type: class
Member Name: Window
Qualified Name: fenic.api.window.Window
Docstring: Represents the specification for a window in window functions.
Including partitioning, ordering, and frame boundaries.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.api.window.Window.__init__ | Creates a new Window. | null | true | false | 38 | 42 | null | null | null | [
"self"
] | null | Window | Type: method
Member Name: __init__
Qualified Name: fenic.api.window.Window.__init__
Docstring: Creates a new Window.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: Window |
method | partition_by | fenic.api.window.Window.partition_by | Returns this Window with the given partitioning columns.
Args:
*cols: Column names or Column expressions to partition by.
Returns:
This Window with updated partitioning (for chaining). | null | true | false | 44 | 54 | null | Window | null | [
"self",
"cols"
] | null | Window | Type: method
Member Name: partition_by
Qualified Name: fenic.api.window.Window.partition_by
Docstring: Returns this Window with the given partitioning columns.
Args:
*cols: Column names or Column expressions to partition by.
Returns:
This Window with updated partitioning (for chaining).
Value: none
Annotation... |
method | order_by | fenic.api.window.Window.order_by | Returns this Window with the given ordering columns.
Args:
*cols: Column names or Column expressions to order by.
Returns:
This Window with updated ordering (for chaining). | null | true | false | 56 | 66 | null | Window | null | [
"self",
"cols"
] | null | Window | Type: method
Member Name: order_by
Qualified Name: fenic.api.window.Window.order_by
Docstring: Returns this Window with the given ordering columns.
Args:
*cols: Column names or Column expressions to order by.
Returns:
This Window with updated ordering (for chaining).
Value: none
Annotation: none
is Public? : ... |
method | rows_between | fenic.api.window.Window.rows_between | Specifies a row-based frame between start (inclusive) and end (exclusive) rows.
Args:
start: Start offset (can be negative).
end: End offset.
Returns:
This Window with row frame boundaries (for chaining). | null | true | false | 68 | 79 | null | Window | null | [
"self",
"start",
"end"
] | null | Window | Type: method
Member Name: rows_between
Qualified Name: fenic.api.window.Window.rows_between
Docstring: Specifies a row-based frame between start (inclusive) and end (exclusive) rows.
Args:
start: Start offset (can be negative).
end: End offset.
Returns:
This Window with row frame boundaries (for chaining)... |
method | range_between | fenic.api.window.Window.range_between | Specifies a range-based frame between start (inclusive) and end (exclusive) values.
Args:
start: Start value.
end: End value.
Returns:
This Window with range frame boundaries (for chaining). | null | true | false | 81 | 92 | null | Window | null | [
"self",
"start",
"end"
] | null | Window | Type: method
Member Name: range_between
Qualified Name: fenic.api.window.Window.range_between
Docstring: Specifies a range-based frame between start (inclusive) and end (exclusive) values.
Args:
start: Start value.
end: End value.
Returns:
This Window with range frame boundaries (for chaining).
Value: non... |
method | _finalize | fenic.api.window.Window._finalize | Internal: Finalizes the window by assigning a default frame if none is set.
This is meant to be called during logical plan construction. | null | false | true | 94 | 113 | null | None | null | [
"self"
] | null | Window | Type: method
Member Name: _finalize
Qualified Name: fenic.api.window.Window._finalize
Docstring: Internal: Finalizes the window by assigning a default frame if none is set.
This is meant to be called during logical plan construction.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self... |
class | _WindowFrame | fenic.api.window._WindowFrame | null | null | false | true | 122 | 147 | null | null | null | null | [] | null | Type: class
Member Name: _WindowFrame
Qualified Name: fenic.api.window._WindowFrame
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __post_init__ | fenic.api.window._WindowFrame.__post_init__ | null | null | true | false | 128 | 147 | null | null | null | [
"self"
] | null | _WindowFrame | Type: method
Member Name: __post_init__
Qualified Name: fenic.api.window._WindowFrame.__post_init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: _WindowFrame |
method | __init__ | fenic.api.window._WindowFrame.__init__ | null | null | true | false | 0 | 0 | null | None | null | [
"self",
"start",
"end",
"frame_type"
] | null | _WindowFrame | Type: method
Member Name: __init__
Qualified Name: fenic.api.window._WindowFrame.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "start", "end", "frame_type"]
Returns: None
Parent Class: _WindowFrame |
module | lineage | fenic.api.lineage | Query interface for tracing data lineage through a query plan. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/api/lineage.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: lineage
Qualified Name: fenic.api.lineage
Docstring: Query interface for tracing data lineage through a query plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | Lineage | fenic.api.lineage.Lineage | Query interface for tracing data lineage through a query plan.
This class allows you to navigate through the query plan both forwards and backwards,
tracing how specific rows are transformed through each operation.
Example:
```python
# Create a lineage query starting from the root
query = LineageQuery(lin... | null | true | false | 12 | 157 | null | null | null | null | [] | null | Type: class
Member Name: Lineage
Qualified Name: fenic.api.lineage.Lineage
Docstring: Query interface for tracing data lineage through a query plan.
This class allows you to navigate through the query plan both forwards and backwards,
tracing how specific rows are transformed through each operation.
Example:
```p... |
method | __init__ | fenic.api.lineage.Lineage.__init__ | Initialize a Lineage instance.
Args:
lineage: The underlying lineage implementation. | null | true | false | 34 | 40 | null | null | null | [
"self",
"lineage"
] | null | Lineage | Type: method
Member Name: __init__
Qualified Name: fenic.api.lineage.Lineage.__init__
Docstring: Initialize a Lineage instance.
Args:
lineage: The underlying lineage implementation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "lineage"]
Returns: none
Parent Class: Lineag... |
method | get_source_names | fenic.api.lineage.Lineage.get_source_names | Get the names of all sources in the query plan. Used to determine where to start the lineage traversal. | null | true | false | 42 | 45 | null | List[str] | null | [
"self"
] | null | Lineage | Type: method
Member Name: get_source_names
Qualified Name: fenic.api.lineage.Lineage.get_source_names
Docstring: Get the names of all sources in the query plan. Used to determine where to start the lineage traversal.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[s... |
method | show | fenic.api.lineage.Lineage.show | Print the operator tree of the query. | null | true | false | 47 | 49 | null | None | null | [
"self"
] | null | Lineage | Type: method
Member Name: show
Qualified Name: fenic.api.lineage.Lineage.show
Docstring: Print the operator tree of the query.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: Lineage |
method | start_from_source | fenic.api.lineage.Lineage.start_from_source | Set the current position to a specific source in the query plan.
Args:
source_name: Name of the source table to start from
Example:
```python
query.start_from_source("customers")
# Now you can trace forward from the customers table
``` | null | true | false | 51 | 64 | null | None | null | [
"self",
"source_name"
] | null | Lineage | Type: method
Member Name: start_from_source
Qualified Name: fenic.api.lineage.Lineage.start_from_source
Docstring: Set the current position to a specific source in the query plan.
Args:
source_name: Name of the source table to start from
Example:
```python
query.start_from_source("customers")
# Now yo... |
method | forwards | fenic.api.lineage.Lineage.forwards | Trace rows forward to see how they are transformed by the next operation.
Args:
row_ids: List of UUIDs identifying the rows to trace
Returns:
DataFrame containing the transformed rows in the next operation
Raises:
ValueError: If at root node or if row_ids format is invalid
Example:
```python
# T... | null | true | false | 66 | 85 | null | pl.DataFrame | null | [
"self",
"row_ids"
] | null | Lineage | Type: method
Member Name: forwards
Qualified Name: fenic.api.lineage.Lineage.forwards
Docstring: Trace rows forward to see how they are transformed by the next operation.
Args:
row_ids: List of UUIDs identifying the rows to trace
Returns:
DataFrame containing the transformed rows in the next operation
Raises... |
method | backwards | fenic.api.lineage.Lineage.backwards | Trace rows backwards to see which input rows produced them.
Args:
ids: List of UUIDs identifying the rows to trace back
branch_side: For operators with multiple inputs (like joins), specify which
input to trace ("left" or "right"). Not needed for single-input operations.
Returns:
DataFrame contain... | null | true | false | 87 | 114 | null | pl.DataFrame | null | [
"self",
"ids",
"branch_side"
] | null | Lineage | Type: method
Member Name: backwards
Qualified Name: fenic.api.lineage.Lineage.backwards
Docstring: Trace rows backwards to see which input rows produced them.
Args:
ids: List of UUIDs identifying the rows to trace back
branch_side: For operators with multiple inputs (like joins), specify which
input to... |
method | skip_forwards | fenic.api.lineage.Lineage.skip_forwards | [Not Implemented] Trace rows forward through multiple operations at once.
This method will allow efficient tracing through multiple operations without
intermediate results.
Args:
row_ids: List of UUIDs identifying the rows to trace
Returns:
DataFrame containing the final transformed rows
Raises:
NotImpl... | null | true | false | 116 | 131 | null | pl.DataFrame | null | [
"self",
"row_ids"
] | null | Lineage | Type: method
Member Name: skip_forwards
Qualified Name: fenic.api.lineage.Lineage.skip_forwards
Docstring: [Not Implemented] Trace rows forward through multiple operations at once.
This method will allow efficient tracing through multiple operations without
intermediate results.
Args:
row_ids: List of UUIDs ident... |
method | skip_backwards | fenic.api.lineage.Lineage.skip_backwards | [Not Implemented] Trace rows backwards through multiple operations at once.
This method will allow efficient tracing through multiple operations without
intermediate results.
Args:
ids: List of UUIDs identifying the rows to trace back
Returns:
Dictionary mapping operation names to their source DataFrames
Ra... | null | true | false | 133 | 148 | null | Dict[str, pl.DataFrame] | null | [
"self",
"ids"
] | null | Lineage | Type: method
Member Name: skip_backwards
Qualified Name: fenic.api.lineage.Lineage.skip_backwards
Docstring: [Not Implemented] Trace rows backwards through multiple operations at once.
This method will allow efficient tracing through multiple operations without
intermediate results.
Args:
ids: List of UUIDs ident... |
method | get_result_df | fenic.api.lineage.Lineage.get_result_df | Get the result of the query as a Polars DataFrame. | null | true | false | 150 | 152 | null | pl.DataFrame | null | [
"self"
] | null | Lineage | Type: method
Member Name: get_result_df
Qualified Name: fenic.api.lineage.Lineage.get_result_df
Docstring: Get the result of the query as a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: pl.DataFrame
Parent Class: Lineage |
method | get_source_df | fenic.api.lineage.Lineage.get_source_df | Get a query source by name as a Polars DataFrame. | null | true | false | 154 | 157 | null | pl.DataFrame | null | [
"self",
"source_name"
] | null | Lineage | Type: method
Member Name: get_source_df
Qualified Name: fenic.api.lineage.Lineage.get_source_df
Docstring: Get a query source by name as a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "source_name"]
Returns: pl.DataFrame
Parent Class: Lineage |
module | column | fenic.api.column | Column API for Fenic DataFrames - represents column expressions and operations. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/api/column.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: column
Qualified Name: fenic.api.column
Docstring: Column API for Fenic DataFrames - represents column expressions and operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | Column | fenic.api.column.Column | A column expression in a DataFrame.
This class represents a column expression that can be used in DataFrame operations.
It provides methods for accessing, transforming, and combining column data.
Example: Create a column reference
```python
# Reference a column by name using col() function
col("column_nam... | null | true | false | 50 | 875 | null | null | null | null | [] | null | Type: class
Member Name: Column
Qualified Name: fenic.api.column.Column
Docstring: A column expression in a DataFrame.
This class represents a column expression that can be used in DataFrame operations.
It provides methods for accessing, transforming, and combining column data.
Example: Create a column reference
... |
method | __new__ | fenic.api.column.Column.__new__ | Prevent direct Column construction. | null | true | false | 77 | 81 | null | null | null | [
"cls"
] | null | Column | Type: method
Member Name: __new__
Qualified Name: fenic.api.column.Column.__new__
Docstring: Prevent direct Column construction.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls"]
Returns: none
Parent Class: Column |
method | get_item | fenic.api.column.Column.get_item | Access an item in a struct or array column.
This method allows accessing elements in complex data types:
- For array columns, the key should be an integer index or a column expression that evaluates to an integer
- For struct columns, the key should be a literal field name
Args:
key (Union[str, int]): The index ... | null | true | false | 83 | 114 | null | Column | null | [
"self",
"key"
] | null | Column | Type: method
Member Name: get_item
Qualified Name: fenic.api.column.Column.get_item
Docstring: Access an item in a struct or array column.
This method allows accessing elements in complex data types:
- For array columns, the key should be an integer index or a column expression that evaluates to an integer
- For stru... |
method | __getitem__ | fenic.api.column.Column.__getitem__ | Access an item in a struct or array column using [] syntax.
This method provides a convenient syntax for accessing elements in complex data types:
- For array columns: col("array_column")[0]
- For struct columns: col("struct_column")["field_name"]
Args:
key (Union[str, int]): The index (for arrays) or field name... | null | true | false | 116 | 146 | null | Column | null | [
"self",
"key"
] | null | Column | Type: method
Member Name: __getitem__
Qualified Name: fenic.api.column.Column.__getitem__
Docstring: Access an item in a struct or array column using [] syntax.
This method provides a convenient syntax for accessing elements in complex data types:
- For array columns: col("array_column")[0]
- For struct columns: col(... |
method | __getattr__ | fenic.api.column.Column.__getattr__ | Access an attribute of a struct column.
This method allows accessing fields in struct columns using dot notation.
Args:
name (str): The name of the field to access
Returns:
Column: A Column representing the accessed field
Example: Access a struct field using dot notation
```python
# Get a field from... | null | true | false | 148 | 169 | null | Column | null | [
"self",
"name"
] | null | Column | Type: method
Member Name: __getattr__
Qualified Name: fenic.api.column.Column.__getattr__
Docstring: Access an attribute of a struct column.
This method allows accessing fields in struct columns using dot notation.
Args:
name (str): The name of the field to access
Returns:
Column: A Column representing the a... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.