type stringclasses 5
values | name stringlengths 1 55 | qualified_name stringlengths 5 130 | docstring stringlengths 15 3.11k ⌀ | filepath stringclasses 90
values | is_public bool 2
classes | is_private bool 2
classes | line_start int64 0 1.44k ⌀ | line_end int64 0 1.51k ⌀ | annotation stringclasses 2
values | returns stringclasses 82
values | value stringclasses 66
values | parameters listlengths 0 10 ⌀ | bases listlengths 0 2 ⌀ | parent_class stringclasses 193
values | api_element_summary stringlengths 199 3.43k |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
method | get_request_key | fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.get_request_key | null | null | true | false | 166 | 168 | null | Any | null | [
"self",
"request"
] | null | AnthropicBatchCompletionsClient | Type: method
Member Name: get_request_key
Qualified Name: fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.get_request_key
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "request"]
Returns: Any
Parent Class: Anthr... |
method | get_metrics | fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.get_metrics | null | null | true | false | 170 | 171 | null | LMMetrics | null | [
"self"
] | null | AnthropicBatchCompletionsClient | Type: method
Member Name: get_metrics
Qualified Name: fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.get_metrics
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: LMMetrics
Parent Class: AnthropicBatchComp... |
method | reset_metrics | fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.reset_metrics | null | null | true | false | 173 | 174 | null | null | null | [
"self"
] | null | AnthropicBatchCompletionsClient | Type: method
Member Name: reset_metrics
Qualified Name: fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.reset_metrics
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: AnthropicBatchCompl... |
method | create_response_format_tool | fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.create_response_format_tool | null | null | true | false | 176 | 185 | null | ToolParam | null | [
"self",
"response_format"
] | null | AnthropicBatchCompletionsClient | Type: method
Member Name: create_response_format_tool
Qualified Name: fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.create_response_format_tool
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "response_format"]
... |
method | convert_messages | fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.convert_messages | null | null | true | false | 187 | 198 | null | tuple[TextBlockParam, list[MessageParam]] | null | [
"self",
"messages"
] | null | AnthropicBatchCompletionsClient | Type: method
Member Name: convert_messages
Qualified Name: fenic._inference.anthropic.anthropic_batch_chat_completions_client.AnthropicBatchCompletionsClient.convert_messages
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "messages"]
Returns: tuple[TextBlockParam... |
module | openai | fenic._inference.openai | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/openai/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: openai
Qualified Name: fenic._inference.openai
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | openai_batch_embeddings_client | fenic._inference.openai.openai_batch_embeddings_client | Client for making batch requests to OpenAI's embeddings API. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/openai/openai_batch_embeddings_client.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: openai_batch_embeddings_client
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client
Docstring: Client for making batch requests to OpenAI's embeddings API.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | OpenAIBatchEmbeddingsClient | fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient | Client for making batch requests to OpenAI's embeddings API. | null | true | false | 22 | 100 | null | null | null | null | [
"ModelClient[str, list[float]]"
] | null | Type: class
Member Name: OpenAIBatchEmbeddingsClient
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient
Docstring: Client for making batch requests to OpenAI's embeddings API.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: non... |
method | __init__ | fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.__init__ | Initialize the OpenAI batch embeddings client.
Args:
rate_limit_strategy: Strategy for handling rate limits
queue_size: Size of the request queue
model: The model to use
max_backoffs: Maximum number of backoff attempts | null | true | false | 25 | 53 | null | null | null | [
"self",
"rate_limit_strategy",
"queue_size",
"model",
"max_backoffs"
] | null | OpenAIBatchEmbeddingsClient | Type: method
Member Name: __init__
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.__init__
Docstring: Initialize the OpenAI batch embeddings client.
Args:
rate_limit_strategy: Strategy for handling rate limits
queue_size: Size of the request queue
model: ... |
method | make_single_request | fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.make_single_request | Make a single request to the OpenAI API.
Args:
request: The request to make
Returns:
The response from the API or an exception | null | true | false | 55 | 66 | null | Union[None, list[float], TransientException, FatalException] | null | [
"self",
"request"
] | null | OpenAIBatchEmbeddingsClient | Type: method
Member Name: make_single_request
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.make_single_request
Docstring: Make a single request to the OpenAI API.
Args:
request: The request to make
Returns:
The response from the API or an exception
Value: ... |
method | get_request_key | fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.get_request_key | Generate a unique key for request deduplication.
Args:
request: The request to generate a key for
Returns:
A unique key for the request | null | true | false | 68 | 77 | null | str | null | [
"self",
"request"
] | null | OpenAIBatchEmbeddingsClient | Type: method
Member Name: get_request_key
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.get_request_key
Docstring: Generate a unique key for request deduplication.
Args:
request: The request to generate a key for
Returns:
A unique key for the request
Value:... |
method | estimate_tokens_for_request | fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.estimate_tokens_for_request | Estimate the number of tokens for a request.
Args:
request: The request to estimate tokens for
Returns:
TokenEstimate with input token count | null | true | false | 79 | 88 | null | TokenEstimate | null | [
"self",
"request"
] | null | OpenAIBatchEmbeddingsClient | Type: method
Member Name: estimate_tokens_for_request
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.estimate_tokens_for_request
Docstring: Estimate the number of tokens for a request.
Args:
request: The request to estimate tokens for
Returns:
TokenEstimate ... |
method | reset_metrics | fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.reset_metrics | Reset all metrics to their initial values. | null | true | false | 90 | 92 | null | null | null | [
"self"
] | null | OpenAIBatchEmbeddingsClient | Type: method
Member Name: reset_metrics
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.reset_metrics
Docstring: Reset all metrics to their initial values.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Clas... |
method | get_metrics | fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.get_metrics | Get the current metrics.
Returns:
The current metrics | null | true | false | 94 | 100 | null | RMMetrics | null | [
"self"
] | null | OpenAIBatchEmbeddingsClient | Type: method
Member Name: get_metrics
Qualified Name: fenic._inference.openai.openai_batch_embeddings_client.OpenAIBatchEmbeddingsClient.get_metrics
Docstring: Get the current metrics.
Returns:
The current metrics
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: RMMe... |
module | openai_batch_chat_completions_client | fenic._inference.openai.openai_batch_chat_completions_client | Client for making batch requests to OpenAI's chat completions API. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/openai/openai_batch_chat_completions_client.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: openai_batch_chat_completions_client
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client
Docstring: Client for making batch requests to OpenAI's chat completions API.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Pare... |
class | OpenAIBatchChatCompletionsClient | fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient | Client for making batch requests to OpenAI's chat completions API. | null | true | false | 24 | 102 | null | null | null | null | [
"ModelClient[FenicCompletionsRequest, FenicCompletionsResponse]"
] | null | Type: class
Member Name: OpenAIBatchChatCompletionsClient
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient
Docstring: Client for making batch requests to OpenAI's chat completions API.
Value: none
Annotation: none
is Public? : true
is Private? : false
Paramet... |
method | __init__ | fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.__init__ | Initialize the OpenAI batch chat completions client.
Args:
rate_limit_strategy: Strategy for handling rate limits
queue_size: Size of the request queue
model: The model to use
max_backoffs: Maximum number of backoff attempts | null | true | false | 27 | 55 | null | null | null | [
"self",
"rate_limit_strategy",
"queue_size",
"model",
"max_backoffs"
] | null | OpenAIBatchChatCompletionsClient | Type: method
Member Name: __init__
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.__init__
Docstring: Initialize the OpenAI batch chat completions client.
Args:
rate_limit_strategy: Strategy for handling rate limits
queue_size: Size of the request ... |
method | make_single_request | fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.make_single_request | Make a single request to the OpenAI API.
Args:
request: The request to make
Returns:
The response from the API or an exception | null | true | false | 57 | 68 | null | Union[None, FenicCompletionsResponse, TransientException, FatalException] | null | [
"self",
"request"
] | null | OpenAIBatchChatCompletionsClient | Type: method
Member Name: make_single_request
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.make_single_request
Docstring: Make a single request to the OpenAI API.
Args:
request: The request to make
Returns:
The response from the API or an except... |
method | get_request_key | fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.get_request_key | Generate a unique key for request deduplication.
Args:
request: The request to generate a key for
Returns:
A unique key for the request | null | true | false | 70 | 79 | null | str | null | [
"self",
"request"
] | null | OpenAIBatchChatCompletionsClient | Type: method
Member Name: get_request_key
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.get_request_key
Docstring: Generate a unique key for request deduplication.
Args:
request: The request to generate a key for
Returns:
A unique key for the req... |
method | estimate_tokens_for_request | fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.estimate_tokens_for_request | Estimate the number of tokens for a request.
Args:
request: The request to estimate tokens for
Returns:
TokenEstimate with input and output token counts | null | true | false | 81 | 90 | null | TokenEstimate | null | [
"self",
"request"
] | null | OpenAIBatchChatCompletionsClient | Type: method
Member Name: estimate_tokens_for_request
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.estimate_tokens_for_request
Docstring: Estimate the number of tokens for a request.
Args:
request: The request to estimate tokens for
Returns:
Tok... |
method | reset_metrics | fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.reset_metrics | Reset all metrics to their initial values. | null | true | false | 92 | 94 | null | null | null | [
"self"
] | null | OpenAIBatchChatCompletionsClient | Type: method
Member Name: reset_metrics
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.reset_metrics
Docstring: Reset all metrics to their initial values.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
... |
method | get_metrics | fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.get_metrics | Get the current metrics.
Returns:
The current metrics | null | true | false | 96 | 102 | null | LMMetrics | null | [
"self"
] | null | OpenAIBatchChatCompletionsClient | Type: method
Member Name: get_metrics
Qualified Name: fenic._inference.openai.openai_batch_chat_completions_client.OpenAIBatchChatCompletionsClient.get_metrics
Docstring: Get the current metrics.
Returns:
The current metrics
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Re... |
module | api | fenic.api | Query module for semantic operations on DataFrames. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/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 | 47 | 98 | null | null | ['Session', 'SessionConfig', 'OpenAIModelConfig', 'AnthropicModelConfig', 'GoogleGLAModelConfig', 'SemanticConfig', 'DataFrameReader', 'DataFrameWriter', 'DataFrame', 'GroupedData', 'SemanticExtensions', 'Column', 'ColumnOrName', 'Catalog', 'semantic', 'text', 'json', 'markdown', 'embedding', 'array', 'array_agg', 'arr... | null | null | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.api.__all__
Docstring: none
Value: ['Session', 'SessionConfig', 'OpenAIModelConfig', 'AnthropicModelConfig', 'GoogleGLAModelConfig', 'SemanticConfig', 'DataFrameReader', 'DataFrameWriter', 'DataFrame', 'GroupedData', 'SemanticExtensions', 'Column', 'ColumnOrNam... |
module | catalog | fenic.api.catalog | Catalog API for managing database objects in Fenic. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/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.
The Catalog provides methods to interact with and manage database tables,
including listing available tables, describing table schemas, and dropping tables.
Example: Basic usage
```python
# Create a new catalog
session.catalog.create_catalog('my_catalog')
# Returns:... | null | true | false | 11 | 509 | null | null | null | null | [] | null | Type: class
Member Name: Catalog
Qualified Name: fenic.api.catalog.Catalog
Docstring: Entry point for catalog operations.
The Catalog provides methods to interact with and manage database tables,
including listing available tables, describing table schemas, and dropping tables.
Example: Basic usage
```python
... |
method | __init__ | fenic.api.catalog.Catalog.__init__ | Initialize a Catalog instance.
Args:
catalog: The underlying catalog implementation. | null | true | false | 43 | 49 | 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 | 52 | 69 | 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 | 71 | 84 | 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 | 86 | 102 | 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 | 104 | 118 | 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 | 120 | 158 | 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 | 160 | 193 | 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 | 195 | 212 | 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 | 214 | 227 | 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 | 229 | 245 | 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 | 247 | 261 | 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 | 263 | 303 | 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 | 305 | 344 | 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 | 346 | 363 | 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 | 365 | 381 | 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:
Schema: A schema object describing the table's structure with field names and types.
Raises:
TableNotFoundError: If the table doesn't exist.
Example: Describe a table's schema
... | null | true | false | 383 | 405 | null | Schema | 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:
Schema: A schema object describing the table's structure with field names... |
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 | 407 | 447 | 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 | 449 | 496 | null | bool | null | [
"self",
"table_name",
"schema",
"ignore_if_exists"
] | 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... |
module | window | fenic.api.window | Window functions for DataFrame operations. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/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.0.0-y6d85svd/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.0.0-y6d85svd/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 | 46 | 866 | 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 | 73 | 77 | 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
- For struct columns, the key should be a field name
Args:
key (Union[str, int]): The index (for arrays) or field name (for structs) to access
Returns:... | null | true | false | 79 | 105 | 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
- For struct columns, the key should be a field name
Args:
... |
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 | 107 | 133 | 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 | 135 | 156 | 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... |
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 | 158 | 182 | 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 | 184 | 234 | 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 | Apply descending order to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A Column expression that provides a column and sort order to the sort function
Example: Sort by age in descending order
```... | null | true | false | 236 | 256 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: desc
Qualified Name: fenic.api.column.Column.desc
Docstring: Apply descending order to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A Column expression that provides a colum... |
method | desc_nulls_first | fenic.api.column.Column.desc_nulls_first | Apply descending order putting nulls first to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function
Returns:
Column: A Column expression that provides a column and sort order to the sort function
Example: Sort by age in desce... | null | true | false | 258 | 278 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: desc_nulls_first
Qualified Name: fenic.api.column.Column.desc_nulls_first
Docstring: Apply descending order putting nulls first to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function
Returns:
Column... |
method | desc_nulls_last | fenic.api.column.Column.desc_nulls_last | Apply descending order putting nulls last to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A Column expression that provides a column and sort order to the sort function
Example: Sort by age in desce... | null | true | false | 280 | 302 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: desc_nulls_last
Qualified Name: fenic.api.column.Column.desc_nulls_last
Docstring: Apply descending order putting nulls last to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: ... |
method | asc | fenic.api.column.Column.asc | Apply ascending order to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A Column expression that provides a column and sort order to the sort function
Example: Sort by age in ascending order
```py... | null | true | false | 304 | 324 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: asc
Qualified Name: fenic.api.column.Column.asc
Docstring: Apply ascending order to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A Column expression that provides a column a... |
method | asc_nulls_first | fenic.api.column.Column.asc_nulls_first | Apply ascending order putting nulls first to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A Column expression that provides a column and sort order to the sort function
Example: Sort by age in ascen... | null | true | false | 326 | 348 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: asc_nulls_first
Qualified Name: fenic.api.column.Column.asc_nulls_first
Docstring: Apply ascending order putting nulls first to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: ... |
method | asc_nulls_last | fenic.api.column.Column.asc_nulls_last | Apply ascending order putting nulls last to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A Column expression that provides a column and sort order to the sort function
Example: Sort by age in ascend... | null | true | false | 350 | 372 | null | Column | null | [
"self"
] | null | Column | Type: method
Member Name: asc_nulls_last
Qualified Name: fenic.api.column.Column.asc_nulls_last
Docstring: Apply ascending order putting nulls last to this column during a dataframe sort or order_by.
This method creates an expression that provides a column and sort order to the sort function.
Returns:
Column: A C... |
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 | 374 | 404 | 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 | 406 | 434 | 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 | 436 | 469 | 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 | 471 | 502 | 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. The pattern must be a literal string
and cannot be a column expression.
Args:
other (str): The regular expression pattern to ... | null | true | false | 504 | 529 | 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. The pattern must be a literal string
and ... |
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 must be a literal string
and cannot be a column expression.
SQL LIKE pattern syntax:
- % matches any sequence of characters
- _ matches ... | null | true | false | 531 | 561 | 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 must be a literal string
and cannot be a column exp... |
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 must be a literal string
and cannot be a column expression.
SQL LIKE pattern syntax:
- % matches any s... | null | true | false | 563 | 593 | 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 must be a liter... |
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 | 595 | 615 | 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 | 617 | 635 | 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 list of conditions and returns one of multiple possible result expressions.
If Column.otherwise() is not invoked, None is returned for unmatched conditions.
Otherwise() will return for rows with None inputs.
Args:
condition (Column): A boolean Column expression
value (Column): A literal value or C... | null | true | false | 637 | 674 | null | Column | null | [
"self",
"condition",
"value"
] | null | Column | Type: method
Member Name: when
Qualified Name: fenic.api.column.Column.when
Docstring: Evaluates a list of conditions and returns one of multiple possible result expressions.
If Column.otherwise() is not invoked, None is returned for unmatched conditions.
Otherwise() will return for rows with None inputs.
Args:
c... |
method | otherwise | fenic.api.column.Column.otherwise | Evaluates a list of conditions and returns one of multiple possible result expressions.
If Column.otherwise() is not invoked, None is returned for unmatched conditions.
Otherwise() will return for rows with None inputs.
Args:
value (Column): A literal value or Column expression to return
Returns:
Column: A C... | null | true | false | 676 | 709 | null | Column | null | [
"self",
"value"
] | null | Column | Type: method
Member Name: otherwise
Qualified Name: fenic.api.column.Column.otherwise
Docstring: Evaluates a list of conditions and returns one of multiple possible result expressions.
If Column.otherwise() is not invoked, None is returned for unmatched conditions.
Otherwise() will return for rows with None inputs.
A... |
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 | 711 | 739 | 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 | null | null | false | true | 741 | 747 | 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: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["cls", "logical_expr"]
Returns: Column
Parent Class: Column |
method | _from_column_name | fenic.api.column.Column._from_column_name | null | null | false | true | 749 | 755 | 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 | 757 | 762 | 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 | 764 | 778 | 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 | 780 | 782 | 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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.